devisable 0.1.0

data/Devisable.gemspec

@@ -0,0 +1,117 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{devisable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Sampson", "Jeremiah Hemphill"]
+  s.date = %q{2011-03-23}
+  s.description = %q{Generates initial code for a devise install.  Gives the options for oauth, using cancan, and creating a user tool to manage the users.}
+  s.email = %q{scott@cloudspace.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Devisable.gemspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/devisable/USAGE",
+    "lib/generators/devisable/devisable_generator.rb",
+    "lib/generators/devisable/templates/app/controllers/registrations_controller.erb",
+    "lib/generators/devisable/templates/app/controllers/users_controller.erb",
+    "lib/generators/devisable/templates/app/controllers/welcome_controller.erb",
+    "lib/generators/devisable/templates/app/helpers/roles_helper.erb",
+    "lib/generators/devisable/templates/app/models/permission.erb",
+    "lib/generators/devisable/templates/app/models/role.erb",
+    "lib/generators/devisable/templates/app/views/roles/_form.erb",
+    "lib/generators/devisable/templates/app/views/roles/edit.erb",
+    "lib/generators/devisable/templates/app/views/roles/index.erb",
+    "lib/generators/devisable/templates/app/views/roles/new.erb",
+    "lib/generators/devisable/templates/app/views/roles/show.erb",
+    "lib/generators/devisable/templates/app/views/shared/_admin_nav.erb",
+    "lib/generators/devisable/templates/app/views/users/_form.erb",
+    "lib/generators/devisable/templates/app/views/users/edit.erb",
+    "lib/generators/devisable/templates/app/views/users/index.erb",
+    "lib/generators/devisable/templates/app/views/users/new.erb",
+    "lib/generators/devisable/templates/app/views/users/show.erb",
+    "lib/generators/devisable/templates/app/views/welcome/welcome_index.erb",
+    "lib/generators/devisable/templates/config/initializers/devise_initializer.erb",
+    "lib/generators/devisable/templates/cucumber/_rake_partial.rb",
+    "lib/generators/devisable/templates/cucumber/devise.feature",
+    "lib/generators/devisable/templates/cucumber/role.feature",
+    "lib/generators/devisable/templates/cucumber/step_definitions/authentication_steps.rb",
+    "lib/generators/devisable/templates/cucumber/step_definitions/generic_steps.rb",
+    "lib/generators/devisable/templates/cucumber/step_definitions/role_steps.rb",
+    "lib/generators/devisable/templates/cucumber/step_definitions/user_steps.rb",
+    "lib/generators/devisable/templates/cucumber/support/_env_partial.rb",
+    "lib/generators/devisable/templates/cucumber/support/_paths_partial.rb",
+    "lib/generators/devisable/templates/cucumber/user.feature",
+    "lib/generators/devisable/templates/partials/_ability_class.rb",
+    "lib/generators/devisable/templates/partials/_access_denied_flash.rb",
+    "lib/generators/devisable/templates/partials/_accessible_permissions_controller.rb",
+    "lib/generators/devisable/templates/partials/_accessible_permissions_model.rb",
+    "lib/generators/devisable/templates/partials/_application_controller_methods.erb",
+    "lib/generators/devisable/templates/partials/_application_controller_methods2.erb",
+    "lib/generators/devisable/templates/partials/_application_current_tab.rb",
+    "lib/generators/devisable/templates/partials/_application_flash.html.erb",
+    "lib/generators/devisable/templates/partials/_environments_development.erb",
+    "lib/generators/devisable/templates/partials/_login_links.erb",
+    "lib/generators/devisable/templates/partials/_migration_down.rb",
+    "lib/generators/devisable/templates/partials/_migration_up.rb",
+    "lib/generators/devisable/templates/partials/_oauth_user_table_fields.erb",
+    "lib/generators/devisable/templates/partials/_permission_equals.rb",
+    "lib/generators/devisable/templates/partials/_permission_manage.js",
+    "lib/generators/devisable/templates/partials/_role_permission.rb",
+    "lib/generators/devisable/templates/partials/_roles_index_delete.erb",
+    "lib/generators/devisable/templates/partials/_user_model_methods.erb",
+    "lib/generators/devisable/templates/partials/_user_role.rb",
+    "lib/generators/devisable/templates/spec/helpers/roles_helper_spec.erb",
+    "lib/generators/devisable/templates/spec/models/ability_spec.erb",
+    "lib/generators/devisable/templates/spec/models/permission_spec.erb",
+    "lib/generators/devisable/templates/spec/models/role_spec.erb",
+    "lib/generators/devisable/templates/spec/models/user_spec.erb",
+    "pkg/devisable-0.1.0.gem",
+    "pkg/devise_generator-0.1.0.gem",
+    "test/helper.rb",
+    "test/test_devise_generator.rb"
+  ]
+  s.homepage = %q{http://github.com/scottsampson/devisable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Generates a complete devise install including cancan, and oauth}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_devise_generator.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Sampson
+
+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,111 @@
+= Devisable
+
+Start your rails project off right with Devisable. 
+
+It is a quick and easy generator that sets up devise,cancan and/or oauth on your site.  It:
+
+* Supports facebook and twitter oauth.
+* Uses cancan permissions
+* Has a user and roles tool so you can change permissions inside a gui
+* Supports all devise options
+* Contains rspec and cucumber test options
+* Can be added to existing project that don't already have devise.
+
+== Installation
+
+Devisable supports rails 3 with ruby >= 1.9.2.
+
+  gem install Devisable
+  
+  Then Add Devisable to your gemfile
+
+  rails generate devisable --help
+  
+== Usage
+
+It is always good practice to start a new branch in your repo before making major updates like when using devisable.
+
+Use --help to see a list of complete options
+  
+Runtime Options:
+  
+  -c, [--config]    # Configuration Options for devise. ie 1,2,3,7,11 (see Devise options below)
+  -t, [--twitteroauth]    # Twitter Oauth key and secret seperated by , (comma). ie 123lk23jjsdfklsd,2l4kljknsdjlsdf
+  -o, [--facebookoauth]    # Facebook Oauth key, secret and client_id seperated by , (comma). ie 123lk23jjsdfklsd,2l4kljknsdjlsdf,102092932
+  -g, [--gems]      # Version of the gems you want to use seperated by Devise,Warden,Cancan. ie 1.1.5,0.1.1,1.5.1  
+  -d, [--denied]        # add this option if you want to add a customized permission denied message
+  -e, [--extra]         # Extra fields added to the user model. ie first_name:string,last_name:string  
+  -n, [--new]           # If the project is brand new.  Will remove the index.html and add the root route
+  -s, [--sudo]          # Use sudo for the gem install commands (for non rvm/osx users)
+  -u, [--url]           # Rool url for your app in development
+  -C, [--cucumber]      # Include cucumber tests, currently does not support oauth
+  
+Devise Options (used with the -c command)
+
+  1.  Database Authenticatable: encrypts and stores a password in the database to validate the authenticity of an user while signing in. The authentication can be done both through POST requests or HTTP Basic Authentication.
+  2.  Token Authenticatable: signs in an user based on an authentication token (also known as “single access token”). The token can be given both through query string or HTTP Basic Authentication.
+  3.  Oauthable: adds OAuth2 support
+  4.  Confirmable: sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in.
+  5.  Recoverable: resets the user password and sends reset instructions.
+  6.  Registerable: handles signing up users through a registration process, also allowing them to edit and destroy their account.
+  7.  Rememberable: manages generating and clearing a token for remembering the user from a saved cookie.
+  8.  Trackable: tracks sign in count, timestamps and IP address.
+  9.  Timeoutable: expires sessions that have no activity in a specified period of time.
+  10. Validatable: provides validations of email and password. It’s optional and can be customized, so you’re able to define your own validations.
+  11. Lockable: locks an account after a specified number of failed sign-in attempts. Can unlock via email or after a specified time period.
+  
+To just setup Basic authentication with devisable
+
+  rails generate devisable
+  
+  This will setup with the devise options 1,4,5,7,8,10
+
+Twitter Oauth - Note you will need to setup your app in twitter before running this
+
+  rails generate devisable -c 2,3 -t <key>,<secret> -u <url_to_your_project>
+
+  rails generate devisable -c 2,3 -t asdf489fhkbnajbsdf,2uh3uh383493hkjdf -u http://dev.yoururl.com
+  
+Facebook Oauth
+
+  rails generate devisable -c 2,3 -o <key>,<secret>,<app_id> -u <url_to_your_project>
+  
+  rails generate devisable -c 2,3 -o asdf489fhkbnajbsdf,2uh3uh383493hkjdf,10100101001 -u http://dev.yoururl.com
+  
+All three (normal authentication,twitter_oauth, facebook_oauth)
+
+  rails generate devisable -c 1,2,3,5,6,7,8 -t asdf489fhkbnajbsdf,2uh3uh383493hkjdf -o asdf489fhkbnajbsdf,2uh3uh383493hkjdf,10100101001 -u http://dev.yoururl.com
+  
+Starting a project - Use the -n option
+
+  rails generate devisable -c 1,2,3,5,6,7,8 -t asdf489fhkbnajbsdf,2uh3uh383493hkjdf -o asdf489fhkbnajbsdf,2uh3uh383493hkjdf,10100101001 -n -u http://dev.yoururl.com
+  
+Add Cucumber tests - use the -C option
+  
+  rails generate devisable -c 1,2,3,5,6,7,8 -t asdf489fhkbnajbsdf,2uh3uh383493hkjdf -o asdf489fhkbnajbsdf,2uh3uh383493hkjdf,10100101001 -n -C -u http://dev.yoururl.com 
+
+Add extra fields to the user model
+
+  rails generate devisable -e first_name:string,last_name:string
+
+== Contributing to devisable
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== TODOS
+
+* Be able to tie your facebook, twitter, and normal authentication options to each other.
+* Support for haml and sass instead of erb
+* Add Facebook javascript autologin option
+
+== Copyright
+
+Copyright (c) 2011 Scott. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "devisable"
+  gem.homepage = "http://github.com/scottsampson/devisable"
+  gem.license = "MIT"
+  gem.summary = "Generates a complete devise install including cancan, and oauth"
+  gem.description = "Generates initial code for a devise install.  Gives the options for oauth, using cancan, and creating a user tool to manage the users."
+  gem.email = "scott@cloudspace.com"
+  gem.authors = ["Scott Sampson","Jeremiah Hemphill"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "devise_generator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/generators/devisable/USAGE

@@ -0,0 +1,57 @@
+Description:
+    This generator will build the code for devise and any necessary requirements such as cancan, warden, oauth.
+    
+    Options for devise include:
+    1.  Database Authenticatable: encrypts and stores a password in the database to validate the authenticity of an user while signing in. The authentication can be done both through POST requests or HTTP Basic Authentication.
+    2.  Token Authenticatable: signs in an user based on an authentication token (also known as “single access token”). The token can be given both through query string or HTTP Basic Authentication.
+    3.  Oauthable: adds OAuth2 support
+    4.  Confirmable: sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in.
+    5.  Recoverable: resets the user password and sends reset instructions.
+    6.  Registerable: handles signing up users through a registration process, also allowing them to edit and destroy their account.
+    7.  Rememberable: manages generating and clearing a token for remembering the user from a saved cookie.
+    8.  Trackable: tracks sign in count, timestamps and IP address.
+    9.  Timeoutable: expires sessions that have no activity in a specified period of time.
+    10. Validatable: provides validations of email and password. It’s optional and can be customized, so you’re able to define your own validations.
+    11. Lockable: locks an account after a specified number of failed sign-in attempts. Can unlock via email or after a specified time period.
+    
+    More runtime options:
+      Runtime options:
+        -c, [--config]    # Configuration Options for devise. ie 1,2,3,7,11
+        -t, [--twitteroauth]    # Twitter Oauth key and secret seperated by , (comma). ie 123lk23jjsdfklsd,2l4kljknsdjlsdf
+        -o, [--facebookoauth]    # Facebook Oauth key, secret and client_id seperated by , (comma). ie 123lk23jjsdfklsd,2l4kljknsdjlsdf,102092932
+        -g, [--gems]      # Version of the gems you want to use seperated by Devise,Warden,Cancan. ie 1.1.5,0.1.1,1.5.1  
+        -d, [--denied]        # add this option if you want to add a customized permission denied message
+        -e, [--extra]         # Extra fields added to the user model. ie first_name:string,last_name:string  
+        -n, [--new]           # If the project is brand new.  Will remove the index.html and add the root route
+        -s, [--sudo]          # Use sudo for the gem install commands (for non rvm/osx users)
+        -u, [--url]           # Rool url for your app in development
+        -C, [--cucumber]      # Include cucumber tests, currently does not support oauth
+    
+    Things you still need to update after you run this:
+      - Add the before filter to each controller.
+        - You can find an example in the applications controller.  Remove from the applications controller.
+      - Clean up the users model.
+      - If you have not done so, remove the index.html and add a root route to your routes.rb file
+      - Move the login/logout links
+        - I added them to layouts/application.html.erb
+      - Fix the navigation
+        - I added the partial to layouts/application.html.erb
+      - If you don't have flash notices you need to add them in your layout
+
+Examples:
+    twitter oauth:
+    
+      rails generate devisable -c 2,3 -t asdf489fhkbnajbsdf,2uh3uh383493hkjdf -g 1.1.5,0.1.1,1.5.1 -r -d  -e first_name:string,last_name:string -u http://dev.yoururl.com
+      
+    facebook oauth: 
+      
+      rails generate devisable -c 2,3 -o asdf489fhkbnajbsdf,2uh3uh383493hkjdf,10201020202 -g 1.1.5,0.1.1,1.5.1 -r -d  -e first_name:string,last_name:string -u http://dev.yoururl.com
+      
+    No oauth:
+    
+      rails generate devisable -c 1,4,5,7,8,10 -g 1.1.5,0.1.1,1.5.1 -r -d -e first_name:string,last_name:string
+      
+    Default run is:
+    
+      rails generate devisable -c 1,4,5,7,8,10
+

data/lib/generators/devisable/devisable_generator.rb

@@ -0,0 +1,484 @@
+require 'rubygems'
+require 'optparse'
+require 'bundler'
+require 'bundler/cli'
+
+class DevisableGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  
+  @@available_configuration_options = {
+    '1' => 'database_authenticatable',
+    '2' => 'token_authenticatable',
+    '3' => 'oauthable',
+    '4' => 'confirmable',
+    '5' => 'recoverable',
+    '6' => 'registerable',
+    '7' => 'rememberable',
+    '8' => 'trackable',
+    '9' => 'timeoutable',
+    '10' => 'validatable',
+    '11' => 'lockable'
+  }
+  @@actual_configuration_options = {
+    'config' => ['1','5','6','7','8','10'],
+    'twitter_oauth' => [],
+    'facebook_oauth' => [],
+    'gems' => ['1.1.5','0.1.1','1.5.1','1.5.1'], #devise, warden_oauth, cancan, json_pure
+    'registration' => false,
+    'denied' => false,
+    'extra' => [],
+    'new' => false,
+    'sudo' => false,
+    'url' => 'http://localhost:3000'
+  }
+  
+  
+  #setups up configuration options from command line
+  #@param runtime_args [string,nil] arguments passed in via command line
+  def initialize(*runtime_args)
+    super(*runtime_args)
+    #@tut_args = runtime_args
+    #@@actual_configuration_options = @tut_args[1].split(',')
+    
+    # -c, [--config] [string]    # Configuration Options for devise. ie 1,2,3,7,11
+    # -o, [--oauth] [string]    # Oauth secret and key seperated by , (comma). ie 123lk23jjsdfklsd,2l4kljknsdjlsdf
+    # -g, [--gems] [string]      # Version of the gems you want to use seperated by Devise,Warden_oauth,Cancan. ie 1.1.5,0.1.1,1.5.1  
+    # -r, [--registration] #add this option if you want to add a customized registration controller
+    # -d, [--denied]        # add this option if you want to add a customized permission denied message
+    # -e, [--extra] [string]         # Extra fields added to the user model. ie first_name:string,last_name:string
+    # -s, [--sudo] # add this option if gem commands need to use sudo
+    
+    
+    OptionParser.new do |opts|
+      opts.banner = "Usage: autoperf.rb [-c config]"
+      
+      opts.on("-c", "--config [string]", String, "Devise configuration options") do |v|
+        @@actual_configuration_options['config'] = v.split(',')
+      end
+      opts.on("-t", "--twitteroauth [string]", String, "twitter oauth key and secret") do |v|
+        @@actual_configuration_options['twitter_oauth'] = v.split(',')
+        if @@actual_configuration_options['twitter_oauth'].length != 2
+          throw_error("You must have both key and secret seperated by comma for -to option.")
+        end
+      end
+      opts.on("-o", "--facebookoauth [string]", String, "facebook oauth key, secret, and client_id") do |v|
+        @@actual_configuration_options['facebook_oauth'] = v.split(',')
+        if @@actual_configuration_options['facebook_oauth'].length != 3
+          throw_error("You must have key, secret, and client_id seperated by comma for -fo option.")
+        end
+      end
+      opts.on("-g", "--gems [string]", String, "Gem Version options") do |v|
+        @@actual_configuration_options['gems'] = v.split(',')
+        if @@actual_configuration_options['gems'].length != 3
+          throw_error("You must have 3 gem versions seperated by comma for -g option. ie devise,warden,cancan")
+        end
+      end
+      opts.on("-d", "--denied [string]", String, "Add customized permission denied message") do |v|
+        @@actual_configuration_options['denied'] = true
+      end
+      opts.on("-e", "--extra [string]", String, "Extra fields added to the user model") do |v|
+        @@actual_configuration_options['extra'] = v.split(',')
+      end
+      opts.on("-n", "--new [string]", String, "Is New Project") do |v|
+        @@actual_configuration_options['new'] = true
+      end
+      opts.on("-s", "--sudo [string]", String, "Using sudo for gem commands") do |v|
+        @@actual_configuration_options['sudo'] = true
+      end
+      opts.on("-u", "--url [string]", String, "Root url for your app in development") do |v|
+        @@actual_configuration_options['url'] = v
+      end
+      opts.on("-C", "--cucumber [string]", String, "Include cucumber tests") do |v|
+        @@actual_configuration_options['cucumber'] = true
+      end
+    end.parse!
+    execute
+  end
+  
+  #stops execution and prints error if an important enough error occurs
+  #@param error [string] The string that gets printed out when the error is thrown
+  def throw_error(error = '')
+    puts error
+    exit();
+  end  
+  
+  #replaces the last string 'end' in a file with the value of rep_str
+  #
+  #@param filename [string] file that will be manipulated
+  #@param rep_str [string] what the last end in the file will be replaced with
+  #@return nil
+  def replace_last_end_in_file_with(filename,rep_str)
+    gsub_file filename , /^(.*)end$/m, "\\1" + rep_str + "\nend"
+  end
+  
+  #Adds all the necessary gems
+  
+  def add_gems
+    sudo = ''
+    if @@actual_configuration_options['sudo']
+      sudo = 'sudo '
+    end
+    gem("devise", @@actual_configuration_options['gems'][0])    
+    gem("warden_oauth", :version => @@actual_configuration_options['gems'][1], :git => "git://github.com/scottsampson/warden_oauth.git")    
+    gem("cancan", @@actual_configuration_options['gems'][2])    
+    gem("json_pure", @@actual_configuration_options['gems'][3])    
+    gem("twitter_oauth", @@actual_configuration_options['gems'][4])
+    
+    # cucumber only gems
+    if @@actual_configuration_options['cucumber']
+      gem("capybara")
+      gem("database_cleaner")
+      gem("cucumber-rails")
+      gem("cucumber")
+      gem("rspec-rails")
+    end
+    Bundler.with_clean_env do
+      output = system("bundle install")
+      if !output
+        err_str = "Gem conflict.  Please make sure your gem versions in your Gemfile match the following:\n\n"
+        err_str += "devise - #{@@actual_configuration_options['gems'][0]}\n"
+        err_str += "warden_oauth - #{@@actual_configuration_options['gems'][1]}\n"
+        err_str += "cancan - #{@@actual_configuration_options['gems'][2]}\n"
+        err_str += "json_pure - #{@@actual_configuration_options['gems'][3]}\n\n\n"
+        throw_error(err_str)
+      end
+    end    
+  end    
+      
+  #generates the devise user with option arguments from the 'extra' configuration options
+  def generate_devise_user
+    extra_args = ''
+    for i in 0...@@actual_configuration_options['extra'].length
+      extra_args << ' ' + @@actual_configuration_options['extra'][i]
+    end
+    unless extra_args.include?('username')  
+      extra_args << ' username:string'
+    end
+    generate("devise:install")
+    generate("devise","user" + extra_args)
+    generate("devise:views")
+  end
+  
+  #takes the options from the command line and
+  #replaces the existing devise configuration in the user model
+  #with the new one.
+  def generate_user_configuration
+    rep_str = ''
+    @@actual_configuration_options['config'].each do |option|
+      rep_str << ', :' + @@available_configuration_options[option]
+    end
+    rep_str = '  devise ' + rep_str[1..-1] + "\n"
+    gsub_file "app/models/user.rb" , /^[ ]*(devise)([^\n]*)(\n)(.*)(\s)/, rep_str
+    
+    rep_str = load_erb_string('partials/_user_model_methods.erb')
+    replace_last_end_in_file_with("app/models/user.rb",rep_str)
+  end
+  
+  #grabs a certain migration file that already exists so it can be modified
+  #@param name excerpt of the name of the file you want
+  #@return the filename you were looking for
+  def get_migration(name)
+    basedir = './db/migrate'
+    Dir.chdir(basedir)
+    file = basedir + '/' + Dir.glob("*" + name + "*").first
+    Dir.chdir('../../')
+    return file
+  end
+  
+  #loads a file from the templates folder and implements erb on it
+  #@param filename [string] Name of the file to be retrieved
+  #@return the data within the file after implementing erb
+  def load_erb_string(filename)
+    @twitter_secret = @@actual_configuration_options['twitter_oauth'][1]
+    @twitter_key = @@actual_configuration_options['twitter_oauth'][0]
+    @facebook_secret = @@actual_configuration_options['facebook_oauth'][1]
+    @facebook_key = @@actual_configuration_options['facebook_oauth'][0]
+    @facebook_client_id = @@actual_configuration_options['facebook_oauth'][2]    
+    file_path = File.expand_path("../templates", __FILE__) + '/' + filename
+    erb_file = ERB.new(File.read(file_path),0,"%")
+    return erb_file.result(binding)
+  end
+  
+  #loads a file from the templates folder WITHOUT implementing erb
+  #@param filename [string] Name of the file to be retrieved
+  #@return the data within the file
+  def load_file_string(filename)
+    file_path = File.expand_path("../templates", __FILE__) + '/' + filename
+    erb_file = File.read(file_path)
+    return erb_file
+  end
+  
+    
+  #checks for oauth
+  #if so adds oauth code  
+  def check_for_oauth
+    @has_twitter_oauth = @@actual_configuration_options['twitter_oauth'].length > 0  ? true : false
+    @has_facebook_oauth = @@actual_configuration_options['facebook_oauth'].length > 0  ? true : false
+    @has_standard_authentication = @@actual_configuration_options['config'].include?('1') ? true : false
+    
+    if @has_twitter_oauth || @had_facebook_oauth
+      
+      @twitter_secret = @@actual_configuration_options['twitter_oauth'][1]
+      @twitter_key = @@actual_configuration_options['twitter_oauth'][0]
+      @facebook_secret = @@actual_configuration_options['facebook_oauth'][1]
+      @facebook_key = @@actual_configuration_options['facebook_oauth'][0]
+      @facebook_client_id = @@actual_configuration_options['facebook_oauth'][2]
+      @url = @@actual_configuration_options['url']
+      #/config/initializers/devise.rb
+      remove_file "config/initializers/devise.rb"
+      template "config/initializers/devise_initializer.erb", "config/initializers/devise.rb"
+      
+      # remove user password from devise sign in page
+      unless @@actual_configuration_options['config'].include?('1')
+        gsub_file "app/views/devise/sessions/new.html.erb", "<p><%= f.label :password %><br />\n", ""
+        gsub_file "app/views/devise/sessions/new.html.erb", "<%= f.password_field :password %></p>\n", ""
+      end
+      
+      #add twitter_oauth
+      keys = load_erb_string('partials/_environments_development.erb')
+      append_to_file "config/environments/development.rb", keys
+      append_to_file "config/environments/test.rb", keys
+      
+      #Add correct fields to the table	
+      user_migration_file = get_migration("devise_create_user")
+      gsub_file user_migration_file, "# t.token_authenticatable", "t.token_authenticatable" 
+      fields = load_erb_string('partials/_oauth_user_table_fields.erb')
+      insert_into_file user_migration_file, fields, :after => "t.token_authenticatable\n"
+      
+      #add correct fields to user model
+      str = "attr_accessible :default_provider, :username\n"
+      insert_into_file "app/models/user.rb", str, :after => "# Setup accessible (or protected) attributes for your model\n"  
+      
+      generate("model", "oauth_profile user_id:integer provider:string token:string secret:string username:string email:string name:string img_url:string")
+            
+      insert_into_file "app/models/oauth_profile.rb", "belongs_to :user\n", :after => "class OauthProfile < ActiveRecord::Base\n"
+      
+      insert_into_file "app/models/user.rb", "has_many :oauth_profiles\n", :after => "class User < ActiveRecord::Base\n"  
+      
+    end
+    
+    # Link to "Login With Twitter/Facebook" somewhere in your view
+    login_links = load_erb_string('partials/_login_links.erb')
+    insert_into_file "app/views/layouts/application.html.erb", login_links, :after => "<body>\n"
+  end
+  
+  #adds confirmable code if the confirmable option for devise is included
+  def confirmable
+    if @@actual_configuration_options['config'].include?('4')
+      user_migration_file = get_migration("devise_create_user")
+      gsub_file user_migration_file, "# t.confirmable", "t.confirmable"
+      
+      insert_into_file "app/controllers/application_controller.rb", "before_filter :mailer_set_url_options\n", :after => "class ApplicationController < ActionController::Base\n"  
+      
+      methods = load_erb_string('partials/_application_controller_methods.erb')
+      gsub_file "app/controllers/application_controller.rb", "end", methods + "\nend"
+    end
+  end
+  
+  #adds lockable code if the lockable option for devise is included
+  def lockable
+    if @@actual_configuration_options['config'].include?('11')
+      user_migration_file = get_migration("devise_create_user")
+      gsub_file user_migration_file, "# t.lockable ", "t.lockable "
+    end
+  end
+  
+  #adds the authenticate calls to the application controller
+  def add_authentication_check_to_controllers
+    insert_into_file "app/controllers/application_controller.rb", "before_filter :authenticate_user!, :except => []\n", :after => "class ApplicationController < ActionController::Base\n"
+    
+    methods = load_erb_string('partials/_application_controller_methods2.erb')
+    insert_into_file "app/controllers/application_controller.rb",methods + "\n", :after => "before_filter :authenticate_user!, :except => []\n"
+  end
+  
+  #installs cancan, updates the ability model, adds permission checks to views
+  def install_cancan
+    generate("cancan:ability")
+    #create the Role model
+    generate("scaffold","Role name:string")
+    generate("model","Permission role_id:integer model:string ability:string")
+    #create the Many To Many relationship between users and roles
+    generate("migration","UsersHaveAndBelongToManyRoles")
+    basedir = './db/migrate'
+    Dir.chdir(basedir)
+    file = basedir + '/' + Dir.glob("*users_have_and_belong_to_many*").first
+    Dir.chdir('../../')
+    self_up_migration = load_erb_string('partials/_migration_up.rb')
+    self_down_migration = load_erb_string('partials/_migration_down.rb')
+    insert_into_file file, self_up_migration, :after => "def self.up\n"
+    insert_into_file file, self_down_migration, :after => "def self.down\n"
+    insert_into_file "app/models/user.rb", "has_and_belongs_to_many :roles\n", :after => "class User < ActiveRecord::Base\n"
+    insert_into_file "app/models/role.rb", "has_and_belongs_to_many :users\n", :after => "class Role < ActiveRecord::Base\n"
+    insert_into_file "app/models/role.rb", "has_many :permissions\nvalidates_presence_of :name\n", :after => "has_and_belongs_to_many :users\n"
+    insert_into_file "app/controllers/roles_controller.rb", "before_filter :accessible_permissions, :only => [:new, :edit, :show, :update, :create]\nload_and_authorize_resource\n", :after => "class RolesController < ApplicationController\n"
+    insert_into_file "app/controllers/roles_controller.rb", "@role.save_permissions(params[:role_ids])\n", :after => "if @role.update_attributes(params[:role])\n"
+    
+    insert_into_file "app/controllers/roles_controller.rb", "@role.save_permissions(params[:role_ids]) \n", :after => "if @role.save\n"
+    insert_into_file "app/models/permission.rb", "belongs_to :role\n", :after => "class Permission < ActiveRecord::Base\n"
+    rep_str = load_erb_string('partials/_permission_equals.rb')
+    insert_into_file "app/models/permission.rb", rep_str, :after => "belongs_to :role\n"
+    
+    rep_str = load_erb_string('partials/_ability_class.rb')
+    gsub_file "app/models/ability.rb" , /^(.*)end$/m, rep_str
+    rep_str = load_erb_string('partials/_user_role.rb')
+    insert_into_file "app/models/user.rb", rep_str, :after => "has_and_belongs_to_many :roles\n"
+  end
+
+  #add a customized registration controller
+  def customize_registration_controller
+    template "app/controllers/registrations_controller.erb", "app/controllers/registrations_controller.rb"
+    gsub_file "config/routes.rb" , "devise_for :users\n", "devise_for :users,  :controllers => { :registrations => \"registrations\" }\n"  
+  end
+  
+  #add a customize permission denied message for cancan  
+  def customize_permission_denied_error
+    if @@actual_configuration_options['denied']
+      rep_str = load_erb_string('partials/_access_denied_flash.rb')
+      insert_into_file "app/controllers/application_controller.rb", rep_str, :after => "protect_from_forgery\n"    
+    end
+  end
+  
+  #creates the user tool instead of using scaffolding
+  def create_user_tool
+    @show_password = @@actual_configuration_options['config'].include?('1')
+    #TODO:  Have to make sure if they have changed the devise_for :users that we account for it here.
+    insert_into_file "config/routes.rb", "resources :users", :after => "devise_for :users,  :controllers => { :registrations => \"registrations\" }\n"    
+    template "app/views/users/index.erb", "app/views/users/index.html.erb"
+    template "app/views/users/new.erb", "app/views/users/new.html.erb"
+    template "app/views/users/show.erb", "app/views/users/show.html.erb"
+    template "app/views/users/edit.erb", "app/views/users/edit.html.erb"
+    template "app/views/users/_form.erb", "app/views/users/_form.html.erb"
+    template "app/controllers/users_controller.erb", "app/controllers/users_controller.rb"
+  end
+  
+  #uses scaffold to create the roles tool but then overrides many of the methods
+  def create_roles_tool
+    #TODO:  Have to make sure if they have changed the devise_for :users that we account for it here.
+    rep_str = load_file_string('partials/_role_permission.rb')
+    insert_into_file "app/helpers/roles_helper.rb", rep_str, :after => "module RolesHelper\n"    
+    #most of this is done in the scaffold above
+    gsub_file "app/views/roles/index.html.erb" , "<td><%= link_to 'Edit', edit_role_path(role) %></td>", "<td><%= link_to_if(can?(:edit, Role), 'Edit', edit_role_path(role)) %></td>"
+    rep_str = load_erb_string('partials/_roles_index_delete.erb')
+    gsub_file "app/views/roles/index.html.erb" , "<td><%= link_to 'Destroy', role, :confirm => 'Are you sure?', :method => :delete %></td>", rep_str
+    
+    gsub_file "app/views/roles/show.html.erb" , "<%= link_to 'Edit', edit_role_path(@role) %>", "<%= link_to_if(can?(:edit, Role), 'Edit', edit_role_path(@role)) %>"
+    gsub_file "app/views/roles/show.html.erb" , "<p id=\"notice\"><%= notice %></p>", ""
+    gsub_file "app/views/roles/_form.html.erb" , /^[\s]*(<div class="actions">)[\s]+(<%= f.submit %>)[\s]+(<\/div>)/m, "<p><%= f.label :permission %></p>\n <ul class=\"no-pad no-bullets\">\n <%= permissions_checkboxes(@role, :permission_ids, @accessible_permissions, @role.id) %>\n </ul>\n <div class=\"actions\">\n      <%= f.submit %>\n    </div>"
+    
+    
+    rep_str = load_erb_string('partials/_accessible_permissions_model.rb')
+    gsub_file "app/models/role.rb", /^(\s)*end\Z/m, rep_str
+    rep_str = load_erb_string('partials/_accessible_permissions_controller.rb')
+    gsub_file "app/controllers/roles_controller.rb" , /^(\s)*end\Z/m, rep_str
+    gsub_file "app/controllers/roles_controller.rb" , "format.html { redirect_to(roles_url) }", "format.html { redirect_to(roles_url, :notice => 'Role was successfully deleted.') }"
+  end
+  
+  #adds the shared navigation to the layout view
+  def create_tool_navigation
+    empty_directory "app/views/shared"
+    template "app/views/shared/_admin_nav.erb", "app/views/shared/_admin_nav.html.erb"
+    rep_str = load_erb_string('partials/_application_current_tab.rb')
+    insert_into_file "app/helpers/application_helper.rb", rep_str, :after => "module ApplicationHelper\n"    
+  end
+  
+  #if the new option is selected removes the index file.  Adds a welcome controller. Adds the root route
+  def new_project
+    if @@actual_configuration_options['new']
+      remove_file "public/index.html"
+      insert_into_file "config/routes.rb", "root :to => 'welcome#index'", :after => "resources :users\n"
+      template "app/controllers/welcome_controller.erb", "app/controllers/welcome_controller.rb"
+      empty_directory "app/views/welcome"
+      template "app/views/welcome/welcome_index.erb", "app/views/welcome/index.html.erb"
+      insert_into_file "config/routes.rb", "root :to => 'welcome#index'", :after => "resources :users\n"
+      rep_str = load_erb_string('partials/_application_flash.html.erb')
+      insert_into_file "app/views/layouts/application.html.erb", rep_str, :after => "<%= render 'shared/admin_nav' %>\n"      
+    end
+  end
+  
+  #adds the javascript for the role permissions checkboxes
+  def add_javascript
+    rep_str = load_erb_string('partials/_permission_manage.js')
+    append_to_file "public/javascripts/application.js", rep_str
+  end
+
+  #adds all the features and steps for cucumber tests
+  def add_cucumber_tests
+    if @@actual_configuration_options['cucumber']
+      generate('cucumber:install')
+      # features
+      template('cucumber/devise.feature', 'features/devise.feature')
+      template('cucumber/user.feature', 'features/user.feature')
+      template('cucumber/role.feature', 'features/role.feature')
+      # step definitions
+      template('cucumber/step_definitions/authentication_steps.rb', 'features/step_definitions/authentication_steps.rb')
+      template('cucumber/step_definitions/generic_steps.rb', 'features/step_definitions/generic_steps.rb')
+      template('cucumber/step_definitions/role_steps.rb', 'features/step_definitions/role_steps.rb')
+      template('cucumber/step_definitions/user_steps.rb', 'features/step_definitions/user_steps.rb')
+      # support 
+      #empty_directory "features/support"
+      rep_str = load_erb_string('cucumber/support/_paths_partial.rb')
+      insert_into_file('features/support/paths.rb', rep_str, :after => "case page_name\n")
+      # this edit to the cucumber env file may be caused by rails 3.0.1 and can be removed after testing
+      gsub_file('features/support/env.rb', "require 'cucumber/rails/capybara_javascript_emulation'", "#require 'cucumber/rails/capybara_javascript_emulation'")
+      # rake task
+      rep_str = load_erb_string('cucumber/_rake_partial.rb')
+      insert_into_file('lib/tasks/cucumber.rake', rep_str, :after => "namespace :cucumber do\n")
+      gsub_file('lib/tasks/cucumber.rake', "task :cucumber => 'cucumber:ok'", "task :cucumber => ['cucumber:setup_js_with_vnc4server', 'cucumber:ok', 'cucumber:kill_js']")
+    end
+  end
+  
+  #if you want to send the confirmable email you need to set the default mailer
+  def add_default_mailer_config
+    rep_str = "config.action_mailer.default_url_options = { :host => \"#{@@actual_configuration_options['url']}\" }\n"
+    insert_into_file "config/environments/development.rb", rep_str, :after => "config.action_mailer.raise_delivery_errors = false\n"
+    insert_into_file "config/environments/test.rb", rep_str, :after => "config.action_mailer.delivery_method = :test\n"
+  end
+  
+  #add a little custom css for the flash notices
+  def modify_css
+    gsub_file('public/stylesheets/scaffold.css', "#notice {", "#notice, div.notice {")
+  end
+  
+  #adds the rspec tests
+  def add_rspec_tests
+    rake('db:create')
+    generate('rspec:install')
+    ['ability_spec','permission_spec','role_spec','user_spec'].each do |filename| 
+      remove_file "spec/models/#{filename}.rb"
+      template("spec/models/#{filename}.erb", "spec/models/#{filename}.rb")
+    end
+    removing_files = ['spec/controllers/roles_controller_spec.rb','spec/helpers/roles_helper_spec.rb']
+    removing_files += ['spec/views/roles/edit.html.erb_spec.rb','spec/views/roles/index.html.erb_spec.rb']
+    removing_files += ['spec/views/roles/new.html.erb_spec.rb','spec/views/roles/show.html.erb_spec.rb','spec/requests/roles_spec.rb']
+    removing_files += ['spec/models/oauth_profile_spec.rb']
+    removing_files.each do |filename|
+      remove_file filename
+    end
+    template('spec/helpers/roles_helper_spec.erb', 'spec/helpers/roles_helper_spec.rb')
+  end
+      
+  #feels a little procedural doesn't it.
+  #executes all the methods above in the correct order.    
+  def execute
+    add_gems
+    generate_devise_user
+    generate_user_configuration
+    check_for_oauth
+    confirmable
+    lockable
+    add_authentication_check_to_controllers
+    install_cancan
+    customize_registration_controller
+    customize_permission_denied_error
+    create_user_tool
+    create_roles_tool
+    create_tool_navigation
+    new_project
+    add_javascript
+    add_cucumber_tests
+    add_default_mailer_config
+    modify_css
+    add_rspec_tests
+  end
+
+end