bborn-desert 0.5.3

data/CHANGES

@@ -0,0 +1,50 @@
+0.5.3
+- optimize load_paths, use uniq!
+- correct bad SQL for recording migrations in plugin_schema_migrations
+
+0.5.0
+- Rails 2.2.3 support
+- routes.rb becomes desert_routes.rb
+- Added Desert::Manager.require_all_files and Desert::Manager.all_files
+
+0.3.4
+- Fix problems with plugin migrations numbered higher than 7
+- Cleanups to specs: cruise rake task, improved docs, and specs run on OSX
+
+0.3.3
+- Fixed [#20770] Can't get specs to run for desert-based plugin bug (http://rubyforge.org/tracker/index.php?func=detail&aid=20770&group_id=6426&atid=24920)
+- Fixed [#21564] Can't see desert rake tasks (http://rubyforge.org/tracker/index.php?func=detail&aid=21564&group_id=6426&atid=24920)
+- Renamed plugin_schema_info to plugin_schema_migrations when using Rails >= 2.1
+- Migrater#migrated are now properly implemented for plugin_schema_migrations for Rails >= 2.1.0
+
+0.3.2
+- Fixed exception in testspec.rake when rspec is not loaded
+- Fix template loading on Edge Rails and on Rails 2.1.0
+
+0.3.1
+- Fix migration issue with Rails 2.1.0 using timestamps.
+
+0.3.0
+- Fixed script/destroy not removing the routes [From Jeff Dean]
+- gem includes the Rails generator files [From Jeff Dean]
+- Fixed readding the route to config/routes.rb in the script/destroy task [From Jeff Dean]
+- Github now properly formats readme [From Jeff Dean]
+- Updated the gemspec so rdoc includes it and updated it to add installation and setup instructions [From Jeff Dean]
+- Removed sample route from generator [From Jeff Dean]
+
+0.2.1
+- Fixed ActionMailer rendering in Rails 1.99.0
+
+0.2.0
+- Works with edge Rails
+- Removed Desert::Plugin#up_to_date?
+- Removed Migrator#latest_version
+
+0.1.1
+- Works with edge Rails
+- Fixed double loading issue with not fully expanded load_paths.
+
+0.1.0
+- Fixed [#13346] ActionController::Base.helper raises error when helper is only in plugin
+- Desert does not require files that have been required before Desert was loaded
+  

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2009 Pivotal Labs
+
+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.rdoc

@@ -0,0 +1,316 @@
+= Desert - It doesn't get any DRYer than this
+
+Desert is a Rails plugin framework that makes it easy to share models, views,
+controllers, helpers, routes, and migrations across your applications.
+
+With Desert, reusability doesn't come at the cost of extensibility: it's trivial to extend
+the functionality of a plugin - both in your application _and_ in other plugins.
+
+Classes are automatically mixed in with your own or other plugins' classes.
+This allows you to make full featured composable components.
+
+Desert is a replacement for Appable Plugins (http://wiki.pluginaweek.org/Appable_plugins).
+
+== Bug/Feature Tracker
+
+Pivotal Tracker: http://www.pivotaltracker.com/projects/358
+
+== Anatomy of a desert plugin
+
+  |-- app
+  |   |-- controllers
+  |   |   |-- application.rb
+  |   |   `-- blogs_controller.rb
+  |   |-- helpers
+  |   |   |-- application_helper.rb
+  |   |   `-- blogs_helper.rb
+  |   |-- models
+  |   |   `-- user.rb
+  |   `-- views
+  |       |-- blogs
+  |       |-- layouts
+  |       |   `-- users.html.erb
+  |       `-- users
+  |           |-- index.html.erb
+  |           `-- show.html.erb
+  |-- db
+  |   `-- migrate
+  |       `-- 001_migrate_users_to_001.rb
+  |-- lib
+  |   `-- current_user.rb
+  |-- spec
+  |   |-- controllers
+  |   |   `-- blogs_controller_spec.rb
+  |   |-- fixtures
+  |   |-- models
+  |   |-- spec_helper.rb
+  |   `-- views
+  |       `-- blogs
+  `-- vendor
+      `-- plugins
+          `-- user
+              |-- app
+              |   |-- controllers
+              |   |   `-- users_controller.rb
+              |   |-- helpers
+              |   |   `-- users_helper.rb
+              |   |-- models
+              |   |   `-- user.rb
+              |   `-- views
+              |       `-- users
+              |           |-- edit.html.erb
+              |           |-- index.html.erb
+              |           |-- new.html.erb
+              |           `-- show.html.erb
+              |-- config
+              |   `-- desert_routes.rb
+              |-- db
+              |   `-- migrate
+              |       `-- 001_create_users.rb
+              |-- init.rb
+              |-- lib
+              |   `-- current_user.rb
+              |-- spec
+              |   |-- controllers
+              |   |   `-- user_controller_spec.rb
+              |   |-- fixtures
+              |   |   `-- users.yml
+              |   |-- models
+              |   |   `-- user.rb
+              |   |-- spec_helper.rb
+              |   `-- views
+              |       `-- users
+              `-- tasks
+
+== Installation and Usage
+
+* Install the gem
+
+    sudo gem install desert
+
+* Require 'desert' between 'boot' and Rails::Initializer.run in environment.rb
+
+    # File: config/environment.rb
+
+    require File.join(File.dirname(__FILE__), 'boot')
+
+    require 'desert'
+
+    Rails::Initializer.run do |config|
+    end
+
+NOTE: you may have to require rubygems before requiring desert.
+
+* Generate your desert plugin
+
+    script/generate desert_plugin my_plugin_app
+
+== Manage Plugin Dependencies
+
+By default, Rails loads plugins in alphabetical order, making it tedious to manage dependencies.
+Desert will automatically load plugins in the proper order when you declare their dependencies like this:
+
+    # File: vendor/plugins/blogs/init.rb
+
+    require_plugin 'user'
+    require_plugin 'will_paginate'
+
+Here <tt>user</tt> and <tt>will_paginate</tt> will always be loaded before <tt>blogs<tt>. Note that any plugin can be declared as a dependency.
+
+== Share Routes
+
+When you share controllers, you'll want to share their routes too.
+If you look in your RAILS_ROOT/config/routes.rb file you will notice that the generator added a new line to the top:
+
+    map.routes_from_plugin(:my_plugin_app)
+
+In the <tt>user</tt> plugin:
+
+    # File: vendor/plugins/user/config/desert_routes.rb
+
+    resource :users
+
+In the <tt>blogs</tt> plugin:
+
+    # File: vendor/plugins/blogs/config/desert_routes.rb
+
+    resource :blogs
+
+In the application:
+
+    # File: config/desert_routes.rb
+
+    ActionController::Routing::Routes.draw do |map|
+      map.routes_from_plugin :blogs
+      map.routes_from_plugin :user
+    end
+
+Here the application adds the <tt>users</tt> resource from the <tt>user</tt> plugin and the <tt>blogs</tt> resource from the <tt>blogs</tt> plugin.
+Notice that there is no need to call methods on map in the plugin route files, because they are instance eval'd in the map object.
+
+All standard routing methods are available in your plugin's routes file, such as:
+
+    namespace :admin do |admin|
+      admin.resources :posts
+    end
+
+Desert uses a separate table to manage migration version to maintain backwards compatibility with Rails 1.x.
+Your plugin app's migration live in your_plugin/db/migrate.  To run migrations, follow these steps:
+
+* Create a new migration in your main app
+
+    script/generate migration migrate_my_plugin_to_045
+
+* Add the custom `migrate_plugin` method
+
+    class MigrateMyPluginTo045 < ActiveRecord::Migration
+      def self.up
+        migrate_plugin(:my_plugin, 20080530223548)
+      end
+
+      def self.down
+        migrate_plugin(:my_plugin, 0)
+      end
+    end
+
+* Run your migrations normally
+
+    rake db:migrate
+
+    connect "/signup", :controller => "users", :action => "signup"
+
+== Share Migrations
+
+Sharing models means sharing schema fragments, and that means sharing migrations:
+
+In the <tt>user</tt> plugin:
+
+  vendor/plugins/user/db/migrate/
+    001_create_user_table.rb
+
+In the <tt>blogs</tt> plugin:
+
+    vendor/plugins/blogs/db/migrate/
+      001_create_user_table.rb
+      002_add_became_a_blogger_at_to_user.rb
+
+Here the <tt>blogs</tt> plugin needs to add a column to the <tt>users</tt> table. No problem!
+It just includes a migration in its <tt>db/migrate</tt> directory, just like a regular Rails application.
+When the application developer installs the plugin, he migrates the plugin in his own migration:
+
+<tt>application_root/db/migrate/009_install_user_and_blogs_plugins.rb</tt>
+
+    class InstallUserAndBlogsPlugins < ActiveRecord::Migration
+      def self.up
+        migrate_plugin 'user', 1
+        migrate_plugin :blogs, 2
+      end
+
+      def self.down
+        migrate_plugin 'user', 0
+        migrate_plugin :blogs, 0
+      end
+    end
+
+Here the application migrates the <tt>user</tt> plugin to version 1 and the <tt>blogs</tt> plugin to version 2.
+If a subsequent version of the plugin introduces new migrations, the application developer has full control over when to apply them to his schema.
+
+== Share Views
+
+To share views, just create templates and partials in the plugin's <tt>app/views</tt> directory, just as you would with a Rails application.
+
+<tt>application_root/app/views/blogs/index.html.erb</tt>
+
+    <%= @blog.posts.each do |post| %>
+      ...
+    <% end %>
+
+== Customize / extend behavior in each installation
+
+Say you want to create a plugin named acts_as_spiffy.
+Desert allows Spiffy to have a set of features that can be reused and extended in several projects.
+
+The Spiffy project has a:
+
+* SpiffyController
+* Spiffy model
+* SpiffyHelper
+* spiffy.html.erb
+* SpiffyLib library class
+
+The Spiffy plugin acts as its own mini Rails application.  Here is the directory structure:
+
+  RAILS_ROOT/vendor/plugins/spiffy/app/controllers/spiffy_controller.rb
+  RAILS_ROOT/vendor/plugins/spiffy/app/models/spiffy.rb
+  RAILS_ROOT/vendor/plugins/spiffy/app/helpers/spiffy_helper.rb
+  RAILS_ROOT/vendor/plugins/spiffy/app/views/spiffy/spiffy.rhtml
+  RAILS_ROOT/vendor/plugins/spiffy/lib/spiffy_lib.rb
+
+Now, say there is a Spiffy Store rails application that uses acts_as_spiffy.  The Rails app can open up any of the Spiffy classes and override any of the methods.
+
+Say spiffy.rb in the Spiffy plugin is defined as:
+
+  class Spiffy < ActiveRecord::Base
+    def why?
+      "I just am Spiffy"
+    end
+  end
+
+The Spiffy#why method can be overridden in RAILS_ROOT/app/models/spiffy.rb
+
+  class Spiffy < ActiveRecord::Base
+    def why?
+      "I sell Spiffy stuff"
+    end
+  end
+
+== Running plugin tests
+
+You can run your plugin tests/specs like so:
+
+  rake desert:testspec:plugins PLUGIN=spiffy
+
+Leaving off the PLUGIN environment variable will cause it to run all the
+test/specs for all installed plugins, which may not be what you want.
+
+== Running Desert Specs
+
+To run specs, you need to:
+
+* Make sure you have the necessary gems installed: 
+
+  sudo geminstaller
+
+* On OSX, you may have to manually install sqlite3-ruby gem 
+
+  sudo env ARCHFLAGS="-arch i386" gem install sqlite3-ruby
+
+* If sqlite3-ruby fails to compile, install it.
+
+  OSX: sudo port install sqlite3
+  Debian: sudo aptitude install sqlite sqlite3 libsqlite-dev libsqlite3-dev
+  
+* Install git http://git.or.cz/
+* Install the dependencies
+
+  rake install_dependencies
+
+* Run the specs
+
+  rake
+
+== Notes on Rails version dependencies
+
+Desert is a library that heavily monkey patches Rails. To ensure that Desert works with
+multiple versions of Rails, its tests are run against the supported versions of Rails.
+
+To set up the different supported versions of Rails, run
+
+  rake install_dependencies
+
+This will clone the Rails git repo and export the supported versions of rails into the
+respective directories.
+
+  rake update_dependencies
+
+will update the clones repo on your machine.

data/Rakefile

@@ -0,0 +1,77 @@
+require "rake"
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc "Runs the Rspec suite"
+task :default do
+  run_suite
+end
+
+desc "Runs the Rspec suite"
+task :spec do
+  run_suite
+end
+
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb") || raise("Example Suite failed")
+end
+
+begin
+  gem "pivotal-jeweler"
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "desert"
+    s.summary = "Desert is a component framework for Rails that allows your plugins to be packaged as mini Rails apps."
+    s.email = "opensource@pivotallabs.com"
+    s.homepage = "http://pivotallabs.com"
+    s.description = "Desert is a component framework for Rails that allows your plugins to be packaged as mini Rails apps."
+    s.authors = ["Pivotal Labs", "Brian Takita", "Parker Thompson", "Adam Milligan, Joe Moore"]
+    s.files =  FileList[
+      '[A-Z]*',
+      '*.rb',
+      'lib/**/*.rb',
+      'generators/**/*',
+      'generators/**/templates/*',
+      'examples/**/*.rb'
+    ].to_a
+    s.extra_rdoc_files = [ "README.rdoc", "CHANGES" ]
+    s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+    s.test_files = Dir.glob('spec/*_spec.rb')
+    s.rubyforge_project = "desert"
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+desc "Install dependencies to run the build. This task uses Git."
+task :install_dependencies do
+  require "lib/desert/supported_rails_versions"
+  system("git clone git://github.com/rails/rails.git ~/Projects/desert/spec/rails_root/vendor/rails_versions/edge")
+  Dir.chdir("spec/rails_root/vendor/rails_versions/edge") do
+    begin
+      Desert::SUPPORTED_RAILS_VERSIONS.each do |version, data|
+        unless version == 'edge'
+          system("git checkout #{data['git_tag']}")
+          system("cp -R ../edge ../#{version}")
+        end
+      end
+    ensure
+      system("git checkout master")
+    end
+  end
+end
+
+desc "Updates the dependencies to run the build. This task uses Git."
+task :update_dependencies do
+  system "cd spec/rails_root/vendor/rails_versions/edge; git pull origin"
+end
+
+desc "Runs the CI build"
+task :cruise => :install_dependencies do
+  run_suite
+end
+