sparkly-auth 1.0.2 → 1.1.0

data/spec/lib/auth_spec.rb

@@ -24,9 +24,9 @@ describe Auth do
       config.authenticate :user, :with => :password
     end
     
-    Auth.configuration.authenticated_models.find(:user).options.without(:behaviors).should == {
+    Auth.configuration.authenticated_models.find(:user).options.without(:behaviors).should include({
       :key => :login,
       :with => :password
-    }
+    })
   end
 end

data/spec/lib/hacks/rename_attributes_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+# Extension to ActiveRecord::Errors to allow error attributes to be renamed. This is
+# because otherwise we'll end up producing very confusing error messages complaining about :secret,
+# :encrypted_secret, and so forth when all the user really cares about is :password.
+#
+# This is mainly for backward compatibility to Rails 2.3, where we had to hack such things into AR.
+describe "Hacks: AR::Errors#rename_attributes" do
+  def errors_on(key)
+    if Rails::VERSION::MAJOR == 3
+      errors[key]
+    else
+      case e = errors.on(key)
+        when nil then []
+        when Array then e
+        else [e]
+      end
+    end
+  end
+  
+  def errors; subject; end
+  
+  subject do
+    errors =
+      if Rails::VERSION::MAJOR == 3
+        ActiveModel::Errors.new(Password.new)
+      else
+        ActiveRecord::Errors.new(Password.new)
+      end
+    
+    errors.add(:unencrypted_secret, "must be unique")
+    errors.add(:password, "must be longer")
+    errors
+  end
+  
+  it "should rename once" do
+    errors.rename_attribute(:unencrypted_secret, :secret)
+    errors_on(:secret).should == ["must be unique"]
+  end
+  
+  it "should rename twice" do
+    errors.rename_attribute(:unencrypted_secret, :secret)
+    errors.rename_attribute(:secret, :password)
+    
+    # order agnostic, else we'd use x.should == ["...","..."]
+    errors_on(:password).should include("must be unique")
+    errors_on(:password).should include("must be longer")
+  end
+end

data/spec/routes_spec.rb

@@ -1,5 +1,7 @@
 describe 'routes' do
-  include ActionController::UrlWriter
+  if Rails::VERSION::MAJOR == 2
+    include ActionController::UrlWriter
+  end
   
   before(:each) do
     Auth.configure do |config|
@@ -7,7 +9,11 @@ describe 'routes' do
     end
     
     Auth.kick!
-    ActionController::Routing::Routes.install_helpers([self.class])
+    if Rails::VERSION::MAJOR == 2
+      ActionController::Routing::Routes.install_helpers([self.class])
+    elsif Rails::VERSION::MAJOR == 3
+      Rails.application.routes.install_helpers([self.class])
+    end
   end
   
   it "should map new_user_path to /user/new" do

data/spec/spec2_helper.rb

@@ -0,0 +1,52 @@
+ENV['RAILS_ENV'] = 'test'
+
+def add_load_path(path)
+  path = File.expand_path(File.join("..", path), __FILE__)
+  $LOAD_PATH.unshift path
+  ActiveSupport::Dependencies.load_paths.unshift path
+  ActiveSupport::Dependencies.load_once_paths.delete path
+end
+
+# Add mock paths to load paths
+add_load_path "mocks/models"
+add_load_path "../app/models"
+#add_load_path "../app/lib"
+add_load_path "../app/controllers"
+
+$LOAD_PATH.uniq!
+ActiveSupport::Dependencies.load_paths.uniq!
+ActiveSupport::Dependencies.load_once_paths.uniq!
+
+undef add_load_path
+
+def column(name)
+  ActiveRecord::ConnectionAdapters::Column.new(name, nil)
+end
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |fi| require fi }
+
+Spec::Runner.configure do |config|
+  # Needed in order to reset configuration for each test. This should not happen in a real environment.
+  config.before(:each) do
+    Auth.reset_double_prevention!
+    apply_sparkly_configuration!
+
+    User.destroy_all
+    Password.destroy_all
+    RemembranceToken.destroy_all
+  end
+  
+  config.extend(ClassHelpers)
+  config.include(InstanceHelpers)
+  config.include(EmailSpec::Helpers)
+  config.include(EmailSpec::Matchers)
+end
+
+def error_on(model, key, value = nil, options = {})
+  instance = model.new()
+  instance.send("#{key}=", value)
+  options.each { |k,v| instance.send("#{k}=", v) }
+
+  instance.valid?
+  instance.errors.on(key.to_s)
+end

data/spec/spec3_helper.rb

@@ -0,0 +1,72 @@
+def add_load_path(path)
+  path = File.expand_path(File.join("..", path), __FILE__)
+  $LOAD_PATH.unshift path
+  ActiveSupport::Dependencies.autoload_paths.unshift path
+  ActiveSupport::Dependencies.autoload_once_paths.unshift path
+end
+
+# Add mock paths to load paths
+add_load_path "mocks/models"
+add_load_path "../app/models"
+#add_load_path "../app/lib"
+add_load_path "../app/controllers"
+
+$LOAD_PATH.uniq!
+ActiveSupport::Dependencies.autoload_paths.uniq!
+ActiveSupport::Dependencies.autoload_once_paths.uniq!
+
+undef add_load_path
+
+def column(name)
+  ActiveRecord::ConnectionAdapters::Column.new(name, nil)
+end
+
+begin
+  require 'genspec'
+rescue LoadError
+  puts " >> Missing gem: 'genspec' <<"
+  puts 
+  puts "These specs rely on genspec, which tests the project's generators."
+  puts
+  raise
+end
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |fi| require fi }
+#gem 'genspec', '0.2.0.prerails3.2'
+
+RSpec.configure do |config|
+  # Needed in order to reset configuration for each test. This should not happen in a real environment.
+  config.before(:each) do
+    Auth.reset_double_prevention!
+    apply_sparkly_configuration!
+
+    User.destroy_all
+    Password.destroy_all
+    RemembranceToken.destroy_all
+  end
+  
+  config.extend(ClassHelpers)
+  config.include(InstanceHelpers)
+  config.include(Rails.application.routes.url_helpers)
+end
+
+def error_on(model, key, value = nil, options = {})
+  instance = model.new()
+  instance.send("#{key}=", value)
+  options.each { |k,v| instance.send("#{k}=", v) }
+  
+  instance.valid?
+  e = instance.errors[key.to_s]
+  
+  # The specs were written to test for Rails 2 errors, and this more or less converts the Rails 3 ones for Rails 2
+  # compatibility.
+  #
+  # TODO: Update the specs for Rails 3, and let the R2 spec helper deal with compatibility.
+  if e.size < 2
+    return e.shift
+  else
+    e
+  end
+end
+
+require 'rspec/rails'

data/spec/spec_helper.rb

@@ -1,61 +1,121 @@
-ENV['RAILS_ENV'] = 'test'
-
-require File.expand_path("../../../../../config/boot", __FILE__)
-require File.expand_path("../../../../../config/environment", __FILE__)
-require "email_spec"
-
-begin
-  require 'genspec'
-rescue LoadError
-  puts " >> Missing gem: 'genspec' <<"
-  puts 
-  puts "These specs rely on gemspec, which tests the project's generators."
-  puts
-  raise
-end
+ENV['DEFER_SPARKLY'] = 'true'  # Sparkly will infer Auth.defer_kickstart from env
+ENV['AUTH_BACKTRACE'] = 'true' # Sparkly will dump backtrace if NameError encountered during init
 
-def add_load_path(path)
-  path = File.expand_path(File.join("..", path), __FILE__)
-  $LOAD_PATH.unshift path
-  ActiveSupport::Dependencies.load_paths.unshift path
-  ActiveSupport::Dependencies.load_once_paths.delete path
+if defined?(RSpec)
+  ENV['RAILS_ENV'] = 'spec'
+  RSPEC_VERSION = 2
+  require File.expand_path(File.join(File.dirname(__FILE__), "../spec_env/rails3/config/boot"))
+  require File.expand_path(File.join(File.dirname(__FILE__), "../spec_env/rails3/config/environment"))
+else
+  ENV['RAILS_ENV'] = 'test'
+  RSPEC_VERSION = 1
+  #require File.expand_path(File.join(File.dirname(__FILE__), "../spec_env/rails2/config/boot"))
+  require File.expand_path(File.join(File.dirname(__FILE__), "../spec_env/rails2/config/environment"))
 end
 
-# Add mock paths to load paths
-add_load_path "mocks/models"
-add_load_path "../app/models"
-#add_load_path "../app/lib"
-add_load_path "../app/controllers"
-
-$LOAD_PATH.uniq!
-ActiveSupport::Dependencies.load_paths.uniq!
-ActiveSupport::Dependencies.load_once_paths.uniq!
-
-undef add_load_path
-
-def column(name)
-  ActiveRecord::ConnectionAdapters::Column.new(name, nil)
+['email_spec', 'genspec'].each do |gem_name|
+  begin
+    require gem_name
+  rescue LoadError
+    puts " >> Missing gem: 'genspec' <<"
+    puts 
+    puts "These specs rely on genspec, which tests the project's generators."
+    puts
+    raise
+  end
 end
 
-Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |fi| require fi }
-
-Spec::Runner.configure do |config|
-  # Needed in order to reset configuration for each test. This should not happen in a real environment.
-  config.before(:each) do
+module InstanceHelpers
+  def reload!
+    if Rails.configuration.cache_classes
+      raise "Cannot reload: set Rails.configuration.cache_classes to false first"
+    end
+    if Rails::VERSION::MAJOR == 2
+      Dispatcher.cleanup_application
+      #Dispatcher.reload_application
+    else
+      ActiveSupport::Dependencies.clear
+      #ActionDispatch::Callbacks.new(Proc.new {}, false).call({})
+    end
+  end
+  
+  def _sparkly_configurations
+    self.class.all_sparkly_configurations
+  end
+  
+  def apply_sparkly_configuration!
+    reload!
     Auth.reset_configuration!
-    Dispatcher.cleanup_application
-    Dispatcher.reload_application
+    if !_sparkly_configurations.empty?
+      _sparkly_configurations.each do |config|
+        Auth.configure &config
+      end
+      Auth.kick! # because we deferred kicking during preparation
+    end
+  end
+end
+
+module ClassHelpers
+  def configure_auth(&block)
+    if block_given?
+      # we have to defer configuration until runtime otherwise all specs will end up
+      # using the last configuration defined, which is an error.
+      self.sparkly_configurations ||= [] # why ?
+      sparkly_configurations << block
+    end
+    sparkly_configurations
+  end
+  
+  def all_sparkly_configurations
+    ret = []
+    ret.concat sparkly_configurations if sparkly_configurations
+    if RSPEC_VERSION == 2 && superclass.respond_to?(:sparkly_configurations)
+      ret = superclass.all_sparkly_configurations + ret # parents should run first.
+    end
+    ret
   end
   
-  config.include(EmailSpec::Helpers)
-  config.include(EmailSpec::Matchers)
+  def self.extended(base)
+    base.instance_eval do
+      class_inheritable_array :sparkly_configurations
+      read_inheritable_attribute(:sparkly_configurations) || write_inheritable_attribute(:sparkly_configurations, [])
+    end
+  end
 end
 
-def error_on(model, key, value = nil, options = {})
-  instance = model.new()
-  instance.send("#{key}=", value)
-  options.each { |k,v| instance.send("#{k}=", v) }
+# a safeguard against the 'old way'
+Auth.class_eval do
+  class << self
+    def reset_double_prevention!
+      @reset_configuration_with_double_prevention = nil
+      @kick_with_double_prevention = nil
+    end
+      
+    def reset_configuration_with_double_prevention!
+      if @reset_configuration_with_double_prevention
+        raise "Auth#reset_configuration! was already called"
+      end
+      @reset_configuration_with_double_prevention = 1
+      reset_configuration_without_double_prevention!
+    end
+
+    def kick_with_double_prevention!
+      if @kick_with_double_prevention
+        raise "Auth#kick! was already called"
+      end
+      @kicm_with_double_prevention = 1
+      kick_without_double_prevention!
+    end
+
+    alias_method_chain :reset_configuration!, :double_prevention
+    alias_method_chain :kick!, :double_prevention
+  end
+end
 
-  instance.valid?
-  instance.errors.on(key.to_s)
+if RSPEC_VERSION == 1
+  require 'spec/rails'
+  require File.join(File.dirname(__FILE__), 'spec2_helper')
+else
+  require 'rspec/rails'
+  require File.join(File.dirname(__FILE__), 'spec3_helper')
 end

data/spec_env/rails2/README.1ST

@@ -0,0 +1,23 @@
+For a gem, this project has a strange file structure. It'll all make sense in about 30 seconds.
+
+The gem is designed to work within a Rails project. Therefore, the best way to test it is within
+a Rails project. I've been trying a lot of different approaches to this, and here's the best
+I've found so far: build the gem within a TEST Rails project's vendor/gems directory, and then
+use config.gem to activate it. This way, it's essentially treated by the Rails project as a
+frozen gem (that is, unpacked into the Rails project tree) -- which, actually, it is.
+
+This approach also circumvents the need to install the gem locally for integration testing,
+but is also not so brittle as my RTML approach (create a 'bootstrap' gem that required the
+files directly). In all, the result is a cleaner, faster test suite and, therefore, dev process.
+
+I've added a nifty ./run_all_tests script to run both the Auth gem's RSpec specs and, assuming
+they pass, it will then run the test project's Features (which comprise the integration portion
+of the test suite).
+
+Obviously, to do any real work on the gem you'll have to chdir into vendor/gems/sparkly-auth-0.
+There's nothing special about the Rails test app, so it should be the same as running the gem
+in any other default Rails app. It's safe to run i.e. Sparkly generators and such on it because
+Sparkly's RSpec suite will override anything those generators produce (or at least, it SHOULD).
+
+The Rakefile in the app's root directory is the same as any Rails rake file; to get to the
+gem-specific Rake tasks, chdir to the frozen gem directory first.

data/spec_env/rails2/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/spec_env/rails2/app/controllers/application_controller.rb

@@ -0,0 +1,13 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+  
+  def not_found
+  end
+end

data/spec_env/rails2/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/spec_env/rails2/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec_env/rails2/app/views/application/not_found.html.erb

@@ -0,0 +1,9 @@
+<h1>404'd!</h1>
+
+<%if current_user%>
+  <%=link_to "Sign out", user_session_path, :method => :delete%>
+  <%=link_to "Edit Profile", edit_user_path%>
+<%else%>
+  <%=link_to "Sign in", new_user_session_path%>
+  <%=link_to "Sign up", new_user_path%>
+<%end%>