https://github.com/markbates/warp_drive

Screw Rails Engines! Why not install a Warp Drive! Completely bundle up an ENTIRE Rails application into a gem, then load it into another application! It's that easy!
https://github.com/markbates/warp_drive

Last synced: 3 months ago
JSON representation

Screw Rails Engines! Why not install a Warp Drive! Completely bundle up an ENTIRE Rails application into a gem, then load it into another application! It's that easy!

• Host: GitHub
• URL: https://github.com/markbates/warp_drive
• Owner: markbates
• License: mit
• Created: 2009-08-31T19:33:36.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2009-12-17T20:45:33.000Z (over 15 years ago)
• Last Synced: 2025-03-30T18:43:55.809Z (4 months ago)
• Language: Ruby
• Homepage: http://www.metabates.com
• Size: 244 KB
• Stars: 34
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • License: LICENSE

Awesome Lists containing this project

README

        
=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.

# $ gem install warp_drive

# $ warpify

  That will add a little bit of code to your Rakefile. That code simply requires the Warp Drive gem, and gives you hooks to configure the gem of your Warp Drive application.

# $ rake warp_drive:compile (rake warp_drive:install)

  This will either compile your gem for your (warp_drive:compile) or compile and install your gem (warp_drive:install)

  

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 Rakefile, so you have access to all the Rakefile tasks in your Warp Drive, and a line in your config/environment.rb so that it will load your Warp Drive when you launch your application.

That's it! You're done. Now you can run rake db:migrate 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 alias_method_chain 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 warp_drive. 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 private 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 foo.rake will be available to clients of your Warp Drive, but bar.rake will not be.

Copyright (c) 2009 Mark Bates