warp_drive 0.1.4 → 0.1.5

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009 markbates
+Copyright (c) 2009 Mark Bates
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -1,3 +1,89 @@
-README
-========================================================================
-warp_drive was developed by: markbates
+=Warp Drive
+
+==What is Warp Drive?
+
+Warp Drive is what Rails Engines wish they could be, and more! They kick Rails templates in the ass, and they beat keeping an ever evolving base Rails app up to date.
+
+===What are Rails Engines?
+
+Rails Engines allow you to package up some of a Rails app (controllers, models, views, routes, libs) and put them in a plugin that can be included into a new Rails app, thereby giving it the functionality you had in the engine. That sounds good, but what about the downsides of using an engine? Well, you can't override or extend any of the functionality from the engine in your main application. You can hack at the plugin, but now you've made it difficult to update. So what do you do if you want to add or alter a method to a controller or model? What do you do if you want to change the look and feel of a view? You have to copy everything into your main application. Boo!
+
+Rails Engines also don't allow you to package up migrations, assets, plugins, initializers, etc... All the fun stuff that you've come to know and love about a Rails application.
+
+===Enter the Warp Drive!
+
+So what is a Warp Drive? Great question. To put it simply a Warp Drive is a standard, full featured, Rails application that you can easily bundle up into a Ruby Gem, and include into another Rails app. That second Rails app now has all the power of the first Rails. That is all there is to it.
+
+==Creating a Warp Drive.
+
+Let's assume we have an application that implements AuthLogic for handling user registration/authentication. We have controllers, views, models, plugins, initializers, configurations, migrations, tasks, etc... it's a full featured fully functional Rails application, we call it authenticator.
+
+We want to turn our authenticator application into a Warp Drive. We can do it in three simple steps, the first two steps you only need to do the first time, to set everything up.
+
+# <code>$ gem install warp_drive</code>
+# <code>$ warpify</code>
+  That will add a little bit of code to your <code>Rakefile</code>. That code simply requires the Warp Drive gem, and gives you hooks to configure the gem of your Warp Drive application.
+# $ <code>rake warp_drive:compile</code> (<code>rake warp_drive:install</code>)
+  This will either compile your gem for your (<code>warp_drive:compile</code>) or compile and install your gem (<code>warp_drive:install</code>)
+  
+That's it! You should now have your Rails application bundled up and/or installed as a RubyGem!
+
+==Using a Warp Drive.
+
+With your fancy new Warp Drive, authenticator, built and installed how do you use it in that new application your building? Again, it's stupid easy, and it only takes one step, that only needs to be run once:
+
+# $ install_warp_drive authenticator
+
+That will put a few lines of code in your <code>Rakefile</code>, so you have access to all the <code>Rakefile</code> tasks in your Warp Drive, and a line in your <code>config/environment.rb</code> so that it will load your Warp Drive when you launch your application.
+
+That's it! You're done. Now you can run <code>rake db:migrate</code> to run the migrations from both your Warp Drive and your new application. Enjoy!
+
+==Overriding, Extending, and Other Such Fun Things
+
+===Overriding and Extending
+
+You've been enjoying your new Warp Drive back application for a little while now, but you decide you really need to change an action in your controller, how do you go about that? Simple, just like you would any normal alteration to a Ruby class.
+
+Example:
+Here is what the action looks like in our Warp Drive UsersController:
+
+  def new
+    @user = User.new
+  end
+
+In our new application we can just open up the UsersController like this:
+
+  class UsersController < ApplicationController
+
+    def new_with_default_name
+      new_without_default_name
+      @user.login = 'default_name'
+    end
+
+    alias_method_chain :new, :default_name
+
+  end
+
+Viola! The same works for any thing else in the system, models, libs, etc... In our example we used <code>alias_method_chain</code> to retain the original method, but we could have completely rewritten the method as well.
+
+You can also plop in a new view and it will override the view that was in your Warp Drive. The sky is really the limit.
+
+===Assets
+
+You can easily bundle assets from your public directory in your Warp Drive. Just make sure they are in folders called <code>warp_drive</code>. Those folders will then be symlinked to your new project's public directory when the application starts up.
+
+===Keep Those Rake Tasks Private!
+
+We all them, Rake tasks we have created to help us do all sorts of things, and we usually don't want them to ship. Well, Warp Drive has you covered there. Just place your tasks in folders called <code>private</code> and Bob's your uncle they won't be available in the compiled gem.
+
+====Example:
+
+  lib/
+    tasks/
+      foo.rake
+      private/
+        bar.rake
+
+In this example <code>foo.rake</code> will be available to clients of your Warp Drive, but <code>bar.rake</code> will not be.
+
+Copyright (c) 2009 Mark Bates

data/lib/warp_drive/boot/method_list.rb

@@ -37,6 +37,6 @@ module WarpDrive
     load_view_paths
     load_application_classes
     disable_dependency_loading
-  }
+  } # :nodoc:
   
 end

data/lib/warp_drive/boot/migration_override.rb

@@ -1,5 +1,5 @@
-module ActiveRecord
-  class Migrator
+module ActiveRecord # :nodoc:
+  class Migrator # :nodoc:
   
     migs = []
     migs << ActiveRecord::Migrator.new(:up, WarpDrive::Path.db.migrate).migrations

data/lib/warp_drive/boot/procs.rb

@@ -1,5 +1,5 @@
 module WarpDrive
-  module Procs
+  module Procs # :nodoc:
     
     class << self
       

data/lib/warp_drive/boot/rails_init.rb

@@ -1,5 +1,5 @@
-module Rails
-  class Initializer
+module Rails # :nodoc:
+  class Initializer # :nodoc:
     
     WarpDrive::RAILS_INIT_METHODS.each do |meth|
       alias_method "#{meth}_without_warp_drive", meth

data/lib/warp_drive/boot/workers.rb

@@ -1,11 +1,11 @@
 module WarpDrive
   extend self
   # --- RAILS --- #
-  def load_plugins
+  def load_plugins # :nodoc:
     Rails.configuration.plugin_paths << WarpDrive::Path.vendor.plugins.to_s
   end
 
-  def set_load_path
+  def set_load_path # :nodoc:
     Rails.configuration.load_paths = [Rails.configuration.load_paths,
                                       WarpDrive::Path.lib.to_s,
                                       WarpDrive::Path.app.to_s,
@@ -14,7 +14,7 @@ module WarpDrive
                                       WarpDrive::Path.app.helpers.to_s].flatten
   end
   
-  def load_gems
+  def load_gems # :nodoc:
     begin
       require('gemtronics')
 
@@ -31,22 +31,22 @@ module WarpDrive
 
   end
   
-  def initialize_routing
+  def initialize_routing # :nodoc:
     ActionController::Routing::Routes.add_configuration_file(WarpDrive::Path.config.routes.rb.to_s)
   end
   
-  def load_view_paths
+  def load_view_paths # :nodoc:
     ActionController::Base.view_paths = [ActionController::Base.view_paths,
                                          WarpDrive::Path.app.views.to_s].flatten
     ActionMailer::Base.view_paths = ActionController::Base.view_paths
   end
   
-  def initialize_dependency_mechanism
+  def initialize_dependency_mechanism # :nodoc:
     ActiveSupport::Dependencies.class_eval do
       class << self
         alias_method :require_or_load_without_warp_drive, :require_or_load
 
-        def require_or_load_with_warp_drive(file_name, const_path = nil)
+        def require_or_load_with_warp_drive(file_name, const_path = nil) # :nodoc:
           sr_file_name = file_name.gsub(RAILS_ROOT, WarpDrive::ROOT)
           require_or_load_without_warp_drive(sr_file_name, const_path) if File.exists?(sr_file_name)
           require_or_load_without_warp_drive(file_name, const_path)
@@ -57,9 +57,9 @@ module WarpDrive
     end
   end
   
-  def initialize_database
+  def initialize_database # :nodoc:
     Rails.configuration.instance_eval do
-      def database_configuration
+      def database_configuration # :nodoc:
         require 'erb'
         db_opts = {}
         
@@ -76,20 +76,20 @@ module WarpDrive
     end # Rails.configuration.instance_eval
   end
   
-  def load_application_initializers
+  def load_application_initializers # :nodoc:
     Dir[File.join(WarpDrive::Path.config.initializers.to_s, '**', '*.rb')].sort.each do |initializer|
       initializer = File.expand_path(initializer)
       load(initializer)
     end
   end
   
-  def initialize_database_middleware
+  def initialize_database_middleware # :nodoc:
     require File.join(File.dirname(__FILE__), 'migration_override')
   end
   
   # --- Non-RAILS --- #
 
-  def load_rake_tasks
+  def load_rake_tasks # :nodoc:
     require 'rake'
     Dir.glob(File.join(WarpDrive::Path.lib.tasks.to_s, '**', '*.*')).sort.each do |task|
       load File.expand_path(task) unless task.match(/\/private\//)
@@ -101,7 +101,7 @@ module WarpDrive
     end
   end
   
-  def load_assets
+  def load_assets # :nodoc:
     Dir.glob(File.join(WarpDrive::ROOT, 'public', '**', 'warp_drive', '**', '*.*')).sort.each do |f|
       f.match(/public\/(.*warp_drive)/)
       base_path = $1
@@ -115,7 +115,7 @@ module WarpDrive
     end
   end
   
-  def method_missing(sym, *args)
+  def method_missing(sym, *args) # :nodoc:
     # puts "Tried to call WarpDrive.#{sym} but it doesn't exist!"
   end
   

data/lib/warp_drive/configure.rb

@@ -2,6 +2,19 @@ module WarpDrive
   
   class << self
     
+    # Use this method in your Rakefile to configure the resulting
+    # Warp Drive gem.
+    # 
+    # Example:
+    #   WarpDrive.configure do |config|
+    #     # Define your gem spec settings here:
+    #     config.gem.version = "1.2.3"
+    #     config.gem.email = 'me@example.com'
+    #     config.gem.homepage = 'http://www.example.com'
+    #   
+    #     # Add your gem dependencies here:
+    #     config.dependencies = {'warp_drive' => '>=0.1.0'}
+    #   end
     def configure
       yield configatron.warp_drive
     end

data/lib/warp_drive/path.rb

@@ -1,4 +1,9 @@
 module WarpDrive
+  # This class allows you to easily get the location of any file or path in a Warp Drive gem.
+  # 
+  # Example:
+  #   WarpDrive::Path.app.controllers.application_controller.rb
+  #   # => "/usr/local/lib/ruby/gems/1.8/gems/my_warp_drive_gem-1.2.3/lib/app/controllers/application_controller.rb"
   class Path
 
     attr_accessor :parent

data/lib/warp_drive/warp_drive_gem_generator.rb

@@ -1,4 +1,4 @@
-class WarpDriveGemGenerator < Genosaurus
+class WarpDriveGemGenerator < Genosaurus # :nodoc:
   require_param :app
   require_param :out_dir
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: warp_drive
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-31 00:00:00 -04:00
+date: 2009-09-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: magrathea
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: warp_drive