sparkly-auth 1.0.2 → 1.1.0

data/generators/sparkly/rails2.rb

@@ -0,0 +1,79 @@
+class SparklyGenerator < Rails::Generator::NamedBase
+  def source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def initialize(args, options = {}) #:nodoc:
+    @options = options
+    unless args.empty?
+      which = args.first
+      @type = which.downcase
+      args << "generic" if nameless_type?
+    end
+    super(args, options)
+  end
+  
+  def manifest
+    record do |m|
+      case @type
+        when *nameless_types then send(@type, m)
+        else raise ArgumentError, "Expected type to be one of #{nameless_types.to_sentence(:connector => 'or ')}"
+      end
+    end
+  end
+  
+  private
+  def help(m)
+    m.directory 'doc'
+    m.file 'help_file.txt', 'doc/sparkly_authentication.txt'
+    logger.log '', File.read(File.join(File.dirname(__FILE__), 'templates/help_file.txt'))
+    logger.quiet = true # we plan to tell the user the file has been saved, so why tell them twice?
+  end
+  
+  def controllers(m)
+    spawn_model_generator(m, Auth::Generators::ControllersGenerator)
+  end
+  
+  def routes(m)
+    spawn_model_generator(m, Auth::Generators::RouteGenerator)
+  end
+  
+  def views(m)
+    spawn_model_generator(m, Auth::Generators::ViewsGenerator)
+  end
+  
+  def migrations(m)
+    spawn_model_generator(m, Auth::Generators::MigrationGenerator)
+  end
+  
+  def config(m)
+    spawn_generator(m, Auth::Generators::ConfigurationGenerator, [])
+  end
+  
+  def spawn_model_generator(manifest, type)
+    each_model do |model|
+      spawn_generator(manifest, type, model)
+    end
+  end
+  
+  def spawn_generator(manifest, type, args)
+    generator = type.new(args, spawned_generator_options)
+    generator.manifest.replay(manifest)
+  end
+  
+  def each_model(&block)
+    Auth.configuration.authenticated_models.each &block
+  end
+  
+  def nameless_type?
+    nameless_types.include? @type
+  end
+  
+  def nameless_types
+    %w(migrations config help views controllers)
+  end
+  
+  def spawned_generator_options
+    options.merge(:source => File.join(source_root), :destination => destination_root)
+  end
+end

data/generators/sparkly/rails3.rb

@@ -0,0 +1,89 @@
+require 'rails/generators'
+
+class SparklyGenerator < Rails::Generators::NamedBase
+  class << self
+    def source_root
+      File.join(File.dirname(__FILE__), "templates")
+    end
+  end
+  
+  def do_generation
+    method_name = "gen_#{file_name.pluralize}"
+    if private_methods.collect { |m| m.to_s }.include?(method_name)  # why doesn't respond_to? work?!
+      send method_name
+    else
+      puts "(not found: #{method_name})"
+      gen_helps
+    end
+  end
+  
+  private
+  def gen_controllers
+    each_model do |model|
+      @model = model
+      template "accounts_controller.rb", File.join("app/controllers", "#{model.accounts_controller.underscore}_controller.rb"),
+                 :assigns => { :model => model }
+      template "sessions_controller.rb", File.join("app/controllers", "#{model.sessions_controller.underscore}_controller.rb"),
+                 :assigns => { :model => model }
+      
+      template "accounts_helper.rb", File.join("app/helpers", "#{model.accounts_controller.underscore}_helper.rb"),
+                 :assigns => { :model => model }
+      template "sessions_helper.rb", File.join("app/helpers", "#{model.sessions_controller.underscore}_helper.rb"),
+                 :assigns => { :model => model }
+      
+    end
+
+    # Controller generator should also kick off the corresponding view generation.
+    gen_views
+  end
+  
+  def gen_helps # yeah, yeah...
+    copy_file 'help_file.txt', 'doc/sparkly_authentication.txt'
+    readme 'help_file.txt'
+  end
+  
+  def gen_configs
+    copy_file "tasks/migrations.rb", "lib/tasks/sparkly_migration.rb"
+    copy_file 'initializer.rb', 'config/initializers/sparkly_authentication.rb'
+  end
+  
+  def gen_migrations
+    mg_version = 0
+    Auth.behavior_classes.each do |behavior|
+      behavior.migrations.each do |file_name|
+        fn_with_ext = file_name[/\.([^\.]+)$/] ? file_name : "#{file_name}.rb"
+        mg_version += 1
+        mg_version_s = mg_version.to_s.rjust(3, '0')
+        template File.join("migrations", fn_with_ext), File.join("db/migrate/#{mg_version_s}_#{fn_with_ext}")
+      end
+    end
+  end
+  
+  def gen_views
+    each_model do |model|
+      @model = model
+      resource_directory = File.join("app/views", model.accounts_controller.underscore)
+      sessions_directory = File.join("app/views", model.sessions_controller.underscore)
+      
+      base = File.join(self.class.source_root, "views/sparkly_accounts")
+      Dir[File.join(base, "**/*")].each do |fi|
+        fi.gsub!(/^#{Regexp::escape base}/, '')
+        copy_file(File.join("views/sparkly_accounts", fi), File.join(resource_directory, fi))
+      end
+
+      base = File.join(self.class.source_root, "views/sparkly_sessions")
+      Dir[File.join(base, "**/*")].each do |fi|
+        fi.gsub!(/^#{Regexp::escape base}/, '')
+        copy_file(File.join("views/sparkly_sessions", fi), File.join(sessions_directory, fi))
+      end
+    end
+  end
+  
+  def models
+    Auth.configuration.authenticated_models
+  end
+  
+  def each_model(&block)
+    models.each &block
+  end
+end

data/generators/sparkly/sparkly_generator.rb

@@ -1,76 +1,5 @@
-class SparklyGenerator < Rails::Generator::NamedBase
-  # I'm still treating this as NamedBase because I'm not sure whether I'll need that in the future.
-  def initialize(args, options = {}) #:nodoc:
-    @options = options
-    unless args.empty?
-      which = args.first
-      @type = which.downcase
-      args << "generic" if nameless_type?
-    end
-    super(args, options)
-  end
-  
-  def manifest
-    record do |m|
-      case @type
-        when *nameless_types then send(@type, m)
-        else raise ArgumentError, "Expected type to be one of #{nameless_types.to_sentence(:connector => 'or ')}"
-      end
-    end
-  end
-  
-  private
-  def help(m)
-    m.directory 'doc'
-    m.file 'help_file.txt', 'doc/sparkly_authentication.txt'
-    logger.log '', File.read(File.join(File.dirname(__FILE__), 'templates/help_file.txt'))
-    logger.quiet = true # we plan to tell the user the file has been saved, so why tell them twice?
-  end
-  
-  def controllers(m)
-    spawn_model_generator(m, Auth::Generators::ControllersGenerator)
-  end
-  
-  def routes(m)
-    spawn_model_generator(m, Auth::Generators::RouteGenerator)
-  end
-  
-  def views(m)
-    spawn_model_generator(m, Auth::Generators::ViewsGenerator)
-  end
-  
-  def migrations(m)
-    spawn_model_generator(m, Auth::Generators::MigrationGenerator)
-  end
-  
-  def config(m)
-    spawn_generator(m, Auth::Generators::ConfigurationGenerator, [])
-  end
-  
-  def spawn_model_generator(manifest, type)
-    each_model do |model|
-      spawn_generator(manifest, type, model)
-    end
-  end
-  
-  def spawn_generator(manifest, type, args)
-    generator = type.new(args, spawned_generator_options)
-    generator.manifest.replay(manifest)
-  end
-  
-  def each_model(&block)
-    Auth.configuration.authenticated_models.each &block
-  end
-  
-  def nameless_type?
-    nameless_types.include? @type
-  end
-  
-  def nameless_types
-    %w(migrations config help views controllers)
-  end
-  
-  def spawned_generator_options
-    options.merge(:source => File.join(source_root), :destination => destination_root)
-  end
+if Rails::VERSION::MAJOR == 2
+  require File.join(File.dirname(__FILE__), 'rails2')
+else
+  require File.join(File.dirname(__FILE__), 'rails3')
 end

data/generators/sparkly/templates/accounts_controller.rb

@@ -1,4 +1,4 @@
-class <%=model.accounts_controller.camelize%>Controller < SparklyController
+class <%=(@model || model).accounts_controller.camelize%>Controller < SparklyController
   require_login_for :show, :edit, :update, :destroy
 
   # GET new_model_url
@@ -7,9 +7,9 @@ class <%=model.accounts_controller.camelize%>Controller < SparklyController
 
   # POST model_url
   def create
-    if model.save       
-      login!(model)
-      redirect_back_or_default Auth.default_destination, Auth.account_created_message
+    if model.save
+      login!(model) if sparkly_config.login_after_signup
+      redirect_back_or_default sparkly_config.default_destination, sparkly_config.account_created_message
     else
       render :action => 'new'
     end
@@ -31,7 +31,7 @@ class <%=model.accounts_controller.camelize%>Controller < SparklyController
     end
     
     if model.save
-      redirect_back_or_default user_path, Auth.account_updated_message
+      redirect_back_or_default user_path, sparkly_config.account_updated_message
     else
       render :action => 'edit'
     end
@@ -42,24 +42,25 @@ class <%=model.accounts_controller.camelize%>Controller < SparklyController
     current_user && current_user.destroy
     logout!
     @current_user = nil
-    flash[:notice] = Auth.account_deleted_message
-    redirect_back_or_default Auth.default_destination
+    flash[:notice] = sparkly_config.account_deleted_message
+    redirect_back_or_default sparkly_config.default_destination
   end
 
   protected
   def find_user_model
     # password fields are protected attrs, so we need to exclude them then add them explicitly.
-    self.model_instance = current_user ||
-            returning(model_class.new(model_params.without(:password, :password_confirmation))) { |model|
-              model.password = model_params[:password]
-              model.password_confirmation = model_params[:password_confirmation]
-            }
+    self.model_instance = current_user || begin
+            model = model_class.new(model_params.without(:password, :password_confirmation))
+            model.password = model_params[:password]
+            model.password_confirmation = model_params[:password_confirmation]
+            model
+    end
   end
 
   # Uncomment if you don't trust the params[:model] set up by Sparkly routing, or if you've
   # disabled them.
   #
   #def model_name
-  #  <%=model.name.inspect%>
+  #  <%=(@model || model).name.inspect%>
   #end
 end

data/generators/sparkly/templates/accounts_helper.rb

@@ -1,2 +1,2 @@
-module <%=model.accounts_controller.camelize%>Helper
+module <%=(@model || model).accounts_controller.camelize%>Helper
 end

data/generators/sparkly/templates/sessions_controller.rb

@@ -1,12 +1,14 @@
-class <%=model.sessions_controller.camelize%>Controller < SparklyController
+class <%=(@model || model).sessions_controller.camelize%>Controller < SparklyController
+  require_logout_for :new, :create
+  
   # GET new_model_session_url
   def new
   end
 
   # POST model_session_url
   def create
-    if session[:locked_out_at] && session[:locked_out_at] > Auth.account_lock_duration.ago
-      flash[:error] = Auth.account_locked_message
+    if session[:locked_out_at] && session[:locked_out_at] > sparkly_config.account_lock_duration.ago
+      flash[:error] = sparkly_config.account_locked_message
       render :action => 'new'
       return
     end
@@ -15,15 +17,15 @@ class <%=model.sessions_controller.camelize%>Controller < SparklyController
                              :include => :passwords)
     
     if model && model.password_matches?(model_params[:password])
-      login! model
-      redirect_back_or_default Auth.default_destination, Auth.login_successful_message
+      login! model, :remember => remember_me?
+      redirect_back_or_default sparkly_config.default_destination, sparkly_config.login_successful_message
     else
       session[:login_failures] = session[:login_failures].to_i + 1
-      if Auth.max_login_failures && session[:login_failures] >= Auth.max_login_failures
+      if sparkly_config.max_login_failures && session[:login_failures] >= sparkly_config.max_login_failures
         session[:locked_out_at] = Time.now
-        flash[:error] = Auth.account_locked_message
+        flash[:error] = sparkly_config.account_locked_message
       else
-        flash[:error] = Auth.invalid_credentials_message
+        flash[:error] = sparkly_config.invalid_credentials_message
       end
       render :action => "new"
     end
@@ -31,15 +33,27 @@ class <%=model.sessions_controller.camelize%>Controller < SparklyController
 
   # DELETE model_session_url
   def destroy
-    logout!
-    redirect_back_or_default Auth.default_destination, Auth.logout_message
+    logout!(:forget => true)
+    redirect_back_or_default sparkly_config.default_destination, sparkly_config.logout_message
   end
   
-  protected
+  private
   # Uncomment if you don't trust the params[:model] set up by Sparkly routing, or if you've
   # disabled them.
   #
   #def model_name
-  #  <%=model.name.inspect%>
+  #  <%=(@model || model).name.inspect%>
   #end
+
+  def remember_me?
+    remembrance = model_params[:remember_me]
+    if remembrance.kind_of?(String)
+      return false if remembrance.blank?
+      return remembrance.to_i != 0
+    elsif remembrance.kind_of?(Numeric)
+      return remembrance != 0
+    else
+      return remembrance
+    end
+  end
 end

data/generators/sparkly/templates/sessions_helper.rb

@@ -1,2 +1,2 @@
-module <%=model.sessions_controller.camelize%>Helper
+module <%=(@model || model).sessions_controller.camelize%>Helper
 end

data/generators/sparkly/templates/views/sparkly_accounts/_rails2_form.html.erb

@@ -0,0 +1,24 @@
+<%form_for model, :url => model_path do |f|%>
+  <p>
+    <%=f.error_messages%>
+  </p>
+
+  <p>
+    <%=f.label model_config.key%><br/>
+    <%=f.text_field model_config.key%>
+  </p>
+
+  <p>
+    <%=f.label :password%><br/>
+    <%=f.password_field :password, :value => ''%>
+  </p>
+
+  <p>
+    <%=f.label :password_confirmation%><br/>
+    <%=f.password_field :password_confirmation, :value => ''%>
+  </p>
+
+  <p>
+    <%=f.submit(model.new_record? ? "Sign up" : "Update Profile")%>
+  </p>
+<%end%>

data/generators/sparkly/templates/views/sparkly_accounts/_rails3_form.html.erb

@@ -0,0 +1,26 @@
+<%=form_for model, :url => model_path do |f|%>
+  <p>
+    <%model.errors.each do |error, message|%>
+      <%=error.to_s.titleize%> <%=message%>
+    <%end%>
+  </p>
+  
+  <p>
+    <%=f.label model_config.key%><br/>
+    <%=f.text_field model_config.key%>
+  </p>
+  
+  <p>
+    <%=f.label :password%><br/>
+    <%=f.password_field :password, :value => ''%>
+  </p>
+  
+  <p>
+    <%=f.label :password_confirmation%><br/>
+    <%=f.password_field :password_confirmation, :value => ''%>
+  </p>
+  
+  <p>
+    <%=f.submit(model.new_record? ? "Sign up" : "Update Profile")%>
+  </p>
+<%end%>