vendor/plugins/restful_authentication/generators/authenticated/authenticated_generator.rb

   1 class AuthenticatedGenerator < Rails::Generator::NamedBase
   2   attr_reader   :controller_name,
   3                 :controller_class_path,
   4                 :controller_file_path,
   5                 :controller_class_nesting,
   6                 :controller_class_nesting_depth,
   7                 :controller_class_name,
   8                 :controller_singular_name,
   9                 :controller_plural_name
  10   alias_method  :controller_file_name,  :controller_singular_name
  11   alias_method  :controller_table_name, :controller_plural_name
  12   attr_reader   :model_controller_name,
  13                 :model_controller_class_path,
  14                 :model_controller_file_path,
  15                 :model_controller_class_nesting,
  16                 :model_controller_class_nesting_depth,
  17                 :model_controller_class_name,
  18                 :model_controller_singular_name,
  19                 :model_controller_plural_name
  20   alias_method  :model_controller_file_name,  :model_controller_singular_name
  21   alias_method  :model_controller_table_name, :model_controller_plural_name
  22
  23   def initialize(runtime_args, runtime_options = {})
  24     super
  25
  26     @controller_name = args.shift || 'sessions'
  27     @model_controller_name = @name.pluralize
  28
  29     # sessions controller
  30     base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
  31     @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
  32
  33     if @controller_class_nesting.empty?
  34       @controller_class_name = @controller_class_name_without_nesting
  35     else
  36       @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
  37     end
  38
  39     # model controller
  40     base_name, @model_controller_class_path, @model_controller_file_path, @model_controller_class_nesting, @model_controller_class_nesting_depth = extract_modules(@model_controller_name)
  41     @model_controller_class_name_without_nesting, @model_controller_singular_name, @model_controller_plural_name = inflect_names(base_name)
  42
  43     if @model_controller_class_nesting.empty?
  44       @model_controller_class_name = @model_controller_class_name_without_nesting
  45     else
  46       @model_controller_class_name = "#{@model_controller_class_nesting}::#{@model_controller_class_name_without_nesting}"
  47     end
  48   end
  49
  50   def manifest
  51     recorded_session = record do |m|
  52       # Check for class naming collisions.
  53       m.class_collisions controller_class_path,       "#{controller_class_name}Controller", # Sessions Controller
  54                                                       "#{controller_class_name}Helper"
  55       m.class_collisions model_controller_class_path, "#{model_controller_class_name}Controller", # Model Controller
  56                                                       "#{model_controller_class_name}Helper"
  57       m.class_collisions class_path,                  "#{class_name}", "#{class_name}Mailer", "#{class_name}MailerTest", "#{class_name}Observer"
  58       m.class_collisions [], 'AuthenticatedSystem', 'AuthenticatedTestHelper'
  59
  60       # Controller, helper, views, and test directories.
  61       m.directory File.join('app/models', class_path)
  62       m.directory File.join('app/controllers', controller_class_path)
  63       m.directory File.join('app/controllers', model_controller_class_path)
  64       m.directory File.join('app/helpers', controller_class_path)
  65       m.directory File.join('app/views', controller_class_path, controller_file_name)
  66       m.directory File.join('app/views', class_path, "#{file_name}_mailer") if options[:include_activation]
  67       m.directory File.join('test/functional', controller_class_path)
  68       m.directory File.join('app/controllers', model_controller_class_path)
  69       m.directory File.join('app/helpers', model_controller_class_path)
  70       m.directory File.join('app/views', model_controller_class_path, model_controller_file_name)
  71       m.directory File.join('test/functional', model_controller_class_path)
  72       m.directory File.join('test/unit', class_path)
  73
  74       m.template 'model.rb',
  75                   File.join('app/models',
  76                             class_path,
  77                             "#{file_name}.rb")
  78
  79       if options[:include_activation]
  80         %w( mailer observer ).each do |model_type|
  81           m.template "#{model_type}.rb", File.join('app/models',
  82                                                class_path,
  83                                                "#{file_name}_#{model_type}.rb")
  84         end
  85       end
  86
  87       m.template 'controller.rb',
  88                   File.join('app/controllers',
  89                             controller_class_path,
  90                             "#{controller_file_name}_controller.rb")
  91
  92       m.template 'model_controller.rb',
  93                   File.join('app/controllers',
  94                             model_controller_class_path,
  95                             "#{model_controller_file_name}_controller.rb")
  96
  97       m.template 'authenticated_system.rb',
  98                   File.join('lib', 'authenticated_system.rb')
  99
 100       m.template 'authenticated_test_helper.rb',
 101                   File.join('lib', 'authenticated_test_helper.rb')
 102
 103       m.template 'functional_test.rb',
 104                   File.join('test/functional',
 105                             controller_class_path,
 106                             "#{controller_file_name}_controller_test.rb")
 107
 108       m.template 'model_functional_test.rb',
 109                   File.join('test/functional',
 110                             model_controller_class_path,
 111                             "#{model_controller_file_name}_controller_test.rb")
 112
 113       m.template 'helper.rb',
 114                   File.join('app/helpers',
 115                             controller_class_path,
 116                             "#{controller_file_name}_helper.rb")
 117
 118       m.template 'model_helper.rb',
 119                   File.join('app/helpers',
 120                             model_controller_class_path,
 121                             "#{model_controller_file_name}_helper.rb")
 122
 123       m.template 'unit_test.rb',
 124                   File.join('test/unit',
 125                             class_path,
 126                             "#{file_name}_test.rb")
 127
 128       if options[:include_activation]
 129         m.template 'mailer_test.rb', File.join('test/unit', class_path, "#{file_name}_mailer_test.rb")
 130       end
 131
 132       m.template 'fixtures.yml',
 133                   File.join('test/fixtures',
 134                             "#{table_name}.yml")
 135
 136       # Controller templates
 137       m.template 'login.rhtml',  File.join('app/views', controller_class_path, controller_file_name, "new.rhtml")
 138       m.template 'signup.rhtml', File.join('app/views', model_controller_class_path, model_controller_file_name, "new.rhtml")
 139
 140       if options[:include_activation]
 141         # Mailer templates
 142         %w( activation signup_notification ).each do |action|
 143           m.template "#{action}.rhtml",
 144                      File.join('app/views', "#{file_name}_mailer", "#{action}.rhtml")
 145         end
 146       end
 147
 148       unless options[:skip_migration]
 149         m.migration_template 'migration.rb', 'db/migrate', :assigns => {
 150           :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
 151         }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
 152       end
 153     end
 154
 155     action = nil
 156     action = $0.split("/")[1]
 157     case action
 158       when "generate"
 159         puts
 160         puts ("-" * 70)
 161         puts "Don't forget to:"
 162         puts
 163         puts "  - add restful routes in config/routes.rb"
 164         puts "    map.resources :#{model_controller_file_name}"
 165         puts "    map.resource  :#{controller_singular_name.singularize}"
 166         puts
 167         puts " Rails 1.2.3 may need a :controller option for the singular resource:"
 168         puts "  - map.resource :#{controller_singular_name.singularize}, :controller => '#{controller_file_name}'"
 169         puts
 170         if options[:include_activation]
 171           puts "    map.activate '/activate/:activation_code', :controller => '#{model_controller_file_name}', :action => 'activate'"
 172           puts
 173           puts "  - add an observer to config/environment.rb"
 174           puts "    config.active_record.observers = :#{file_name}_observer"
 175         end
 176         puts
 177         puts "Try these for some familiar login URLs if you like:"
 178         puts
 179         puts "  map.signup '/signup', :controller => '#{model_controller_file_name}', :action => 'new'"
 180         puts "  map.login  '/login', :controller => '#{controller_file_name}', :action => 'new'"
 181         puts "  map.logout '/logout', :controller => '#{controller_file_name}', :action => 'destroy'"
 182         puts
 183         puts ("-" * 70)
 184         puts
 185       when "destroy"
 186         puts
 187         puts ("-" * 70)
 188         puts
 189         puts "Thanks for using restful_authentication"
 190         puts
 191         puts "Don't forget to comment out the observer line in environment.rb"
 192         puts "  (This was optional so it may not even be there)"
 193         puts "  # config.active_record.observers = :#{file_name}_observer"
 194         puts
 195         puts ("-" * 70)
 196         puts
 197       else
 198         puts
 199     end
 200
 201     recorded_session
 202   end
 203
 204   protected
 205     # Override with your own usage banner.
 206     def banner
 207       "Usage: #{$0} authenticated ModelName [ControllerName]"
 208     end
 209
 210     def add_options!(opt)
 211       opt.separator ''
 212       opt.separator 'Options:'
 213       opt.on("--skip-migration",
 214              "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
 215       opt.on("--include-activation",
 216              "Generate signup 'activation code' confirmation via email") { |v| options[:include_activation] = v }
 217     end
 218 end