rails3_devise_wizard 0.2 → 0.2.1

data/README.textile

@@ -1,16 +1,24 @@
 h1. Rails3 Devise Wizard Gem
 
-A gem to create a ready-to-run Rails web application you can deploy in minutes.
+Creates a ready-to-run Rails web application using Devise for authentication. Makes it easy to create and maintain a starter app using your own preferred options. This is the gem used to create the "rails3-mongoid-devise":http://github.com/fortuity/rails3-mongoid-devise/ example application, as described in a detailed "tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29.
 
-This gem can be used to create the "rails3-mongoid-devise":http://github.com/fortuity/rails3-mongoid-devise/ example application, as described in a detailed "tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29.
+h4. Based on Michael Bleigh's RailsWizard Gem
 
-h2. Based on Michael Bleigh's RailsWizard Gem
+The rails3_devise_wizard gem is a fork of "Michael Bleigh's RailsWizard gem":https://github.com/intridea/rails_wizard (see credits below). The purpose of this fork is to provide recipes for a ready-to-run Rails web application that uses Devise for authentication. Several recipes provided by the rails3_devise_wizard gem are different from those provided by the rails_wizard gem. Applications generated with the rails3_devise_wizard gem are more complete; for example, they may include a home page with sign-in, sign-out navigation links.
 
-The rails3_devise_wizard gem is a fork of "Michael Bleigh's RailsWizard gem":https://github.com/intridea/rails_wizard (see credits below). The purpose of this fork is to provide recipes for a ready-to-run Rails web application that uses Devise for authentication.
+h2. Suggested Use
+
+Any developer can quickly generate a Rails web application using the @rails new@ command. In practice, experienced Rails developers typically add an assortment of useful additional packages (gems) before beginning development of any web application. A developer often uses the same set of packages to get started and may create a "starter app" that can be copied and reused for any new project.
+
+It can be a hassle to integrate some of the most commonly used packages, particularly when new versions are released and there are minor "gotchas" that interfere with packages working together. Despite the apparent convenience of creating a starter app, it can be time consuming to maintain and update a starter app as component packages evolve. This project aims to simplify the process of building and maintaining a starter app by providing mix-and-match recipes to assemble the most commonly used Rails packages.
+
+If you use this gem to create your Rails starter app, you can expect the pieces to work together. If they don't, you can report problems and look for identified "issues":http://github.com/fortuity/rails3_devise_wizard/issues (and perhaps contributed fixes).
+
+If you use this gem to create a reusable application template (see the instructions below), you can check for changes to recipes here and reassemble your application template as packages evolve.
 
 h2. Dependencies
 
-Before generating a new Rails app using an application template, you will need:
+Before generating a new Rails app, you will need:
 
 * The Ruby language (version 1.8.7 or 1.9.2)
 * Rails (version 3.0.4 or newer)
@@ -28,44 +36,93 @@ h2. Installation
 
 Installation is simple:
 
-bc. gem install rails3_devise_wizard, :git => 'git://github.com/fortuity/rails3_devise_wizard.git'
-
+@$ gem install rails3_devise_wizard@
 
 h2. Usage
 
-The @rails3_devise_wizard@ gem offers an interactive terminal command to build a Rails application template. To get started, run:
+h4. List Recipes
+
+You can display a list of recipes:
+
+@$ rails3_devise_wizard list@
+
+You'll find more details about the available recipes by browsing the repository "recipes directory":https://github.com/fortuity/rails3_devise_wizard/tree/master/recipes. 
+
+h4. Generate a Starter App
+
+You can build an application by providing a list of recipes with the @-r@ option. For example, to build the "rails3-mongoid-devise":http://github.com/fortuity/rails3-mongoid-devise/ example application, run the command:
+
+<pre>
+$ rails3_devise_wizard new APP_NAME -r git jquery haml rspec cucumber mongoid action_mailer devise add_user_name home_page home_page_users seed_database users_page css_setup application_layout devise_navigation cleanup ban_spiders
+</pre>
+
+This will automatically generate an application using the specified recipes.
+
+h2. Make Your Own Starter App (the Easy Way)
+
+h4. Select Recipes
+
+You can mix and match recipes to create your own customized starter app. Browse the repository "recipes directory":https://github.com/fortuity/rails3_devise_wizard/tree/master/recipes to see what is available. Then provide your list of recipes to the rails3_devise_wizard gem using the @-r@ option and generate an app as needed. Here's an example that creates a simple app using jquery and haml:
+
+<pre>
+$ rails3_devise_wizard new APP_NAME -r jquery haml
+</pre>
+
+h2. Make Your Own Starter App (the Advanced Way)
 
-bc. rails3_devise_wizard new APP_NAME
+You can modify the recipes and save an application template that creates your own customized starter app.
 
+First, you'll need to make your own copy of the rails3_devise_wizard gem.
 
-Where @APP_NAME@ is the directory in which you wish to create the app (it mirrors the Rails creation syntax). You will then be guided through the recipe selection process and subsequently the Rails app generator will automatically run with the template and all appropriate command line options included.
+@$ git clone git://github.com/fortuity/rails3_devise_wizard.git@
 
-h4. Specifying Recipes
+@$ cd rails3_devise_wizard@
 
-If you wish to skip the interactive recipe selector, you may provide instead a list of recipes with the @-r@ option:
+Install the "mg":https://github.com/sr/mg "minimal gem" which is required for development of the rails3_devise_wizard gem:
 
-bc. rails3_devise_wizard new APP_NAME -r jquery mongo_mapper sass
+@$ gem install mg@
 
+h4. Customize the Recipes
 
-This will automatically generate a Rails template with the provided recipes and launch the app generator.
+Modify or write new recipes as you wish (see below for details about writing recipes). You can run @rake spec@ to make sure your recipes conform to the required syntax.
 
-h4. Listing Recipes
+h4. Save the Application Template
 
-You can also print out a simple list of recipes:
+The rails3_devise_wizard gem creates an application template as an intermediate step before generating an application. You can generate and save the application template. Here's an example of generating an application template and saving the template to a file:
 
-bc. rails3_devise_wizard list
+<pre>
+$ rake print RECIPES=recipe1,recipe2 > ~/Desktop/template.txt
+</pre>
+
+h4. Edit the Application Template
 
+The application template is generated with an extraneous first line. Open the template file and remove the first line if it doesn't begin with a comment.
 
-Or print out a list of recipes for a specific category:
+h4. Generate an Application from an Application Template
 
-bc. rails3_devise_wizard list persistence
+The rails3_devise_wizard gem creates an application template that can be used by the @rails new@ command with the @-m@ option. For example:
+
+<pre>
+$ rails new testapp -m ~/Desktop/template.txt
+</pre>
+
+You can specify the @-T -O -J@ flags as needed to skip Test::Unit files, Active Record files, and Prototype files.
+
+Here's an example:
+
+<pre>
+$ rails new testapp -m ~/Desktop/recipe.txt -T -O -J
+</pre>
 
+That's all it takes. You'll have a ready-to-customize Rails web application in minutes.
 
-h2. Rails3 Devise Wizard Recipes
+h2. Writing New Recipes
 
-You can find the rails3_devise_wizard recipe collection in the GitHub repository's "recipes directory":https://github.com/fortuity/rails3_devise_wizard/tree/master/recipes. If you find errors or fork a recipe you can submit a pull request or create a "Github issue":http://github.com/fortuity/rails3_devise_wizard/issues.
+You can find the rails3_devise_wizard recipe collection in the GitHub repository's "recipes directory":https://github.com/fortuity/rails3_devise_wizard/tree/master/recipes. If you find errors or improve a recipe you can contribute to the project by submitting a pull request or creating a "Github issue":http://github.com/fortuity/rails3_devise_wizard/issues.
 
-h4. Writing New Recipes
+h4. Rails Wizard Basics
+
+For more information on all available options for authoring recipes that can be read by the rails_wizard or rails3_devise_wizard gems, please see the "wiki for Michael Bleigh's  RailsWizard gem":https://github.com/intridea/rails_wizard/wiki.
 
 Recipes are made of up *template code* and *YAML back-matter* stored in a ruby file. The @__END__@ parsing convention is used so that each recipe is actually a valid, parseable Ruby file. The structure of a recipe looks something like this:
 
@@ -84,11 +141,25 @@ description: Installs SuperGem which is useful for things
 author: mbleigh
 </pre>
 
-The gem has RSpec tests that automatically validate each recipe in the repository, so you should run @rake spec@ as a basic sanity check before submitting a pull request. Note that these don't verify that your recipe code itself works, just that the gem could properly parse and understand your recipe file.
+h4. Rails3 Devise Wizard Differences
+
+The rails3_devise_wizard gem is very similar to the rails_wizard gem, with one significant difference. The rails_wizard gem allows specification of execution order for recipes with @run_after@ and @run_after@ configuration flags. The rails3_devise_wizard gem does not support @run_after@ or @run_after@; instead, the order which you provide the recipes sets the execution order. This makes it easier to chain a series of recipes in the order you prefer. For example,
+
+<pre>
+$ rails3_devise_wizard new APP_NAME -r git jquery haml
+</pre>
+
+installs jquery before haml.
+
+h4. Recipe Differences
+
+Several recipes provided by the rails3_devise_wizard gem are different from those provided by the rails_wizard gem.
 
-For more information on all available options for authoring recipes, please see the "wiki for Michael Bleigh's  RailsWizard gem":https://github.com/intridea/rails_wizard/wiki.
+h4. Rails Wizard RSpec Tests
 
-h2. How It Works
+The gem has RSpec tests that automatically validate each recipe in the repository, so you should run @rake spec@ as a basic syntax check. Note that these don't verify that your recipe code itself works, just that the gem could properly parse and understand your recipe file.
+
+h4. How It Works
 
 Rails generators can use any methods provided by the "Thor::Actions":http://rdoc.info/github/wycats/thor/master/Thor/Actions module. The flexibility of mixing "recipes" for application templates comes from use of the @apply@ method from the Thor::Actions module. Given a web address or a local filepath, the "apply method":http://rdoc.info/github/wycats/thor/master/Thor/Actions#apply-instance_method loads and executes a file within the context of the generator script.
 
@@ -100,8 +171,6 @@ h4. Writing Recipes
 
 To understand the code in these templates, take a look at "Thor::Actions":http://rdoc.info/github/wycats/thor/master/Thor/Actions. Your recipes can use any methods provided by "Thor::Actions":http://rdoc.info/github/wycats/thor/master/Thor/Actions or "Rails::Generators::Actions":http://railsapi.com/doc/rails-v3.0.3/classes/Rails/Generators/Actions.html.
 
-Please send a message (via GitHub) or a "pull request" if you've written recipes you'd like to contribute.
-
 h4. About Rails Application Templates
 
 "Cooking Up A Custom Rails 3 Template (11 Oct 2010) by Andrea Singh":http://blog.madebydna.com/all/code/2010/10/11/cooking-up-a-custom-rails3-template.html
@@ -122,7 +191,7 @@ This project is based on "Michael Bleigh's RailsWizard gem":https://github.com/i
 
 RSpec, Cucumber, and Yard recipes were contributed by "Ramon Brooker":http://cogniton-mind.tumblr.com/.
 
-Additional recipes by me, Daniel Kehoe "http://danielkehoe.com/":http://danielkehoe.com/, to implement the "rails3-mongoid-devise":http://github.com/fortuity/rails3-mongoid-devise/ example application.
+Additional recipes by Daniel Kehoe, "http://danielkehoe.com/":http://danielkehoe.com/, to implement the "rails3-mongoid-devise":http://github.com/fortuity/rails3-mongoid-devise/ example application.
 
 Is the gem useful to you? Follow me on Twitter:
 "http://twitter.com/railsinit":http://twitter.com/railsinit

data/recipes/devise.rb

@@ -23,6 +23,29 @@ after_bundler do
   # Generate models and routes for a User
   generate 'devise user'
 
+  if recipes.include? 'rspec'
+    # copy all the RSpec specs files from the rails3-mongoid-devise example app
+    inside 'spec' do
+      get 'https://github.com/fortuity/rails3-mongoid-devise/raw/master/spec/factories.rb', 'factories.rb'
+    end
+    remove_file 'spec/controllers/home_controller_spec.rb'
+    remove_file 'spec/controllers/users_controller_spec.rb'
+    inside 'spec/controllers' do
+      get 'https://github.com/fortuity/rails3-mongoid-devise/raw/master/spec/controllers/home_controller_spec.rb', 'home_controller_spec.rb'
+      get 'https://github.com/fortuity/rails3-mongoid-devise/raw/master/spec/controllers/users_controller_spec.rb', 'users_controller_spec.rb'
+    end
+    remove_file 'spec/models/user_spec.rb'
+    inside 'spec/models' do
+      get 'https://github.com/fortuity/rails3-mongoid-devise/raw/master/spec/models/user_spec.rb', 'user_spec.rb'
+    end
+    remove_file 'spec/views/home/index.html.erb_spec.rb'
+    remove_file 'spec/views/home/index.html.haml_spec.rb'
+    remove_file 'spec/views/users/show.html.erb_spec.rb'
+    remove_file 'spec/views/users/show.html.haml_spec.rb'
+    remove_file 'spec/helpers/home_helper_spec.rb'
+    remove_file 'spec/helpers/users_helper_spec.rb'
+  end
+
 end
 
 __END__

data/version.rb

@@ -1,3 +1,3 @@
 module RailsWizard
-  VERSION = "0.2"
+  VERSION = "0.2.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: rails3_devise_wizard
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.2"
+  version: 0.2.1
 platform: ruby
 authors: 
 - Daniel Kehoe
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2754679886023976313
+      hash: -448456634312592260
       segments: 
       - 0
       version: "0"
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2754679886023976313
+      hash: -448456634312592260
       segments: 
       - 0
       version: "0"