clearance 1.6.0 → 1.6.1

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 1.0"
+gem "ammeter"
+gem "aruba", "~> 0.5"
+gem "bundler", "~> 1.3"
+gem "capybara", "~> 2.2.0"
+gem "cucumber-rails", "~> 1.3", :require => false
+gem "database_cleaner", "~> 1.0"
+gem "factory_girl_rails", "~> 4.2"
+gem "rspec-rails", "~> 3.1"
+gem "shoulda-matchers", "~> 2.4"
+gem "sqlite3", "~> 1.3"
+gem "timecop", "~> 0.6"
+gem "pry", :require => false
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/clearance/configuration.rb

@@ -27,7 +27,7 @@ module Clearance
     end
 
     def user_model
-      @user_model || ::User
+      @user_model ||= ::User
     end
 
     def allow_sign_up?

data/lib/clearance/session.rb

@@ -6,10 +6,14 @@ module Clearance
 
     def initialize(env)
       @env = env
+      @current_user = nil
+      @cookies = nil
     end
 
     def add_cookie_to_headers(headers)
-      Rack::Utils.set_cookie_header!(headers, REMEMBER_TOKEN_COOKIE, cookie_value)
+      if cookie_value[:value].present?
+        Rack::Utils.set_cookie_header!(headers, REMEMBER_TOKEN_COOKIE, cookie_value)
+      end
     end
 
     def current_user

data/lib/clearance/testing/deny_access_matcher.rb

@@ -1,5 +1,3 @@
-require 'clearance/testing/assertion_error'
-
 module Clearance
   module Testing
     module Matchers
@@ -66,7 +64,7 @@ module Clearance
             @failure_message_when_negated <<
               "Didn't expect to redirect to #{@url}."
             true
-          rescue Clearance::Testing::AssertionError
+          rescue MiniTest::Assertion
             @failure_message << "Expected to redirect to #{@url} but did not."
             false
           end

data/lib/clearance/version.rb

@@ -1,3 +1,3 @@
 module Clearance
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

data/lib/generators/clearance/install/install_generator.rb

@@ -12,17 +12,17 @@ module Clearance
       end
 
       def inject_clearance_into_application_controller
-        inject_into(
+        inject_into_class(
+          "app/controllers/application_controller.rb",
           ApplicationController,
-          'app/controllers/application_controller.rb',
-          'include Clearance::Controller'
+          "  include Clearance::Controller\n"
         )
       end
 
       def create_or_inject_clearance_into_user_model
-        if File.exists? 'app/models/user.rb'
+        if File.exist? "app/models/user.rb"
           inject_into_file(
-            'app/models/user.rb',
+            "app/models/user.rb",
             "include Clearance::User\n\n",
             after: "class User < ActiveRecord::Base\n"
           )
@@ -66,16 +66,6 @@ module Clearance
         end
       end
 
-      def inject_into(class_name, file, text)
-        if file_does_not_contain?(file, text)
-          inject_into_class file, class_name, "  #{text}\n"
-        end
-      end
-
-      def file_does_not_contain?(file, text)
-        File.readlines(file).grep(/#{text}/).none?
-      end
-
       def migration_needed?
         new_columns.any? || new_indexes.any?
       end

data/spec/clearance/session_spec.rb

@@ -320,7 +320,7 @@ describe Clearance::Session do
     headers = {}
     session = Clearance::Session.new(env_without_remember_token)
     session.add_cookie_to_headers headers
-    expect(headers).not_to set_cookie('remember_token')
+    expect(headers["Set-Cookie"]).to be nil
   end
 
   it 'signs out a user' do

data/spec/dummy/application.rb

@@ -0,0 +1,47 @@
+require "rails/all"
+
+module Dummy
+  APP_ROOT = File.expand_path("..", __FILE__).freeze
+
+  def self.rails4?
+    Rails::VERSION::MAJOR >= 4
+  end
+
+  I18n.enforce_available_locales = true
+
+  class Application < Rails::Application
+    config.action_controller.allow_forgery_protection = false
+    config.action_controller.perform_caching = false
+    config.action_dispatch.show_exceptions = false
+    config.action_mailer.default_url_options = { host: "dummy.example.com" }
+    config.action_mailer.delivery_method = :test
+    config.active_support.deprecation = :stderr
+    config.active_support.test_order = :random
+    config.assets.enabled = true
+    config.cache_classes = true
+    config.consider_all_requests_local = true
+    config.eager_load = false
+    config.encoding = "utf-8"
+    config.paths["app/controllers"] << "#{APP_ROOT}/app/controllers"
+    config.paths["app/views"] << "#{APP_ROOT}/app/views"
+    config.paths["config/database"] = "#{APP_ROOT}/config/database.yml"
+    config.paths["log"] = "tmp/log/development.log"
+    config.secret_token = "SECRET_TOKEN_IS_MIN_30_CHARS_LONG"
+
+    if Dummy.rails4?
+      config.paths.add "config/routes.rb", with: "#{APP_ROOT}/config/routes.rb"
+      config.secret_key_base = "SECRET_KEY_BASE"
+    else
+      config.paths.add "config/routes", with: "#{APP_ROOT}/config/routes.rb"
+    end
+
+    def require_environment!
+      initialize!
+    end
+
+    def initialize!(&block)
+      FileUtils.mkdir_p(Rails.root.join("db").to_s)
+      super unless @initialized
+    end
+  end
+end

data/spec/generators/clearance/install/install_generator_spec.rb

@@ -0,0 +1,118 @@
+require "spec_helper"
+require "generators/clearance/install/install_generator"
+
+describe Clearance::Generators::InstallGenerator, :generator do
+  describe "initializer" do
+    it "is copied to the application" do
+      provide_existing_application_controller
+
+      run_generator
+      initializer = file("config/initializers/clearance.rb")
+
+      expect(initializer).to exist
+      expect(initializer).to have_correct_syntax
+      expect(initializer).to contain("Clearance.configure do |config|")
+    end
+  end
+
+  describe "application controller" do
+    it "includes Clearance::Controller" do
+      provide_existing_application_controller
+
+      run_generator
+      application_controller = file("app/controllers/application_controller.rb")
+
+      expect(application_controller).to have_correct_syntax
+      expect(application_controller).to contain("include Clearance::Controller")
+    end
+  end
+
+  describe "user_model" do
+    context "no existing user class" do
+      it "creates a user class including Clearance::User" do
+        provide_existing_application_controller
+
+        run_generator
+        user_class = file("app/models/user.rb")
+
+        expect(user_class).to exist
+        expect(user_class).to have_correct_syntax
+        expect(user_class).to contain("include Clearance::User")
+      end
+    end
+
+    context "user class already exists" do
+      it "includes Clearance::User" do
+        provide_existing_application_controller
+        provide_existing_user_class
+
+        run_generator
+        user_class = file("app/models/user.rb")
+
+        expect(user_class).to exist
+        expect(user_class).to have_correct_syntax
+        expect(user_class).to contain("include Clearance::User")
+        expect(user_class).to have_method("previously_existed?")
+      end
+    end
+  end
+
+  describe "user migration" do
+    context "users table does not exist" do
+      it "creates a migration to create the users table" do
+        provide_existing_application_controller
+        allow(ActiveRecord::Base.connection).to receive(:table_exists?).
+          with(:users).
+          and_return(false)
+
+        run_generator
+        migration = migration_file("db/migrate/create_users.rb")
+
+        expect(migration).to exist
+        expect(migration).to have_correct_syntax
+        expect(migration).to contain("create_table :users")
+      end
+    end
+
+    context "existing users table with all clearance columns and indexes" do
+      it "does not create a migration" do
+        provide_existing_application_controller
+
+        run_generator
+        create_migration = migration_file("db/migrate/create_users.rb")
+        add_migration = migration_file("db/migrate/add_clearance_to_users.rb")
+
+        expect(create_migration).not_to exist
+        expect(add_migration).not_to exist
+      end
+    end
+
+    context "existing users table missing some columns and indexes" do
+      it "create a migration to add missing columns and indexes" do
+        provide_existing_application_controller
+        Struct.new("Named", :name)
+        existing_columns = [Struct::Named.new("remember_token")]
+        existing_indexes = [Struct::Named.new("index_users_on_remember_token")]
+
+        allow(ActiveRecord::Base.connection).to receive(:columns).
+          with(:users).
+          and_return(existing_columns)
+
+        allow(ActiveRecord::Base.connection).to receive(:indexes).
+          with(:users).
+          and_return(existing_indexes)
+
+        run_generator
+        migration = migration_file("db/migrate/add_clearance_to_users.rb")
+
+        expect(migration).to exist
+        expect(migration).to have_correct_syntax
+        expect(migration).to contain("change_table :users")
+        expect(migration).to contain("t.string :email")
+        expect(migration).to contain("add_index :users, :email")
+        expect(migration).not_to contain("t.string :remember_token")
+        expect(migration).not_to contain("add_index :users, :remember_token")
+      end
+    end
+  end
+end

data/spec/generators/clearance/routes/routes_generator_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+require "generators/clearance/routes/routes_generator"
+
+describe Clearance::Generators::RoutesGenerator, :generator do
+  it "adds clearance routes to host application routes" do
+    provide_existing_routes_file
+
+    routes = file("config/routes.rb")
+
+    run_generator
+
+    expect(routes).to have_correct_syntax
+    expect(routes).to contain(
+      "get '/sign_in' => 'clearance/sessions#new', as: 'sign_in'"
+    )
+  end
+end

data/spec/generators/clearance/specs/specs_generator_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "generators/clearance/specs/specs_generator"
+
+describe Clearance::Generators::SpecsGenerator, :generator do
+  it "copies specs to host app" do
+    run_generator
+
+    specs = %w(
+      factories/clearance
+      features/clearance/user_signs_out_spec
+      features/clearance/visitor_resets_password_spec
+      features/clearance/visitor_signs_in_spec
+      features/clearance/visitor_signs_up_spec
+      features/clearance/visitor_updates_password_spec
+      support/clearance
+      support/features/clearance_helpers
+    )
+
+    spec_files = specs.map { |spec| file("spec/#{spec}.rb") }
+
+    spec_files.each do |spec_file|
+      expect(spec_file).to exist
+      expect(spec_file).to have_correct_syntax
+    end
+  end
+end

data/spec/generators/clearance/views/views_generator_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+require "generators/clearance/views/views_generator"
+
+describe Clearance::Generators::ViewsGenerator, :generator do
+  it "copies clearance views to the host application" do
+    run_generator
+
+    views = %w(
+      clearance_mailer/change_password
+      layouts/application
+      passwords/create
+      passwords/edit
+      passwords/new
+      sessions/_form
+      sessions/new
+      users/_form
+      users/new
+    )
+
+    view_files = views.map { |view| file("app/views/#{view}.html.erb") }
+
+    view_files.each do |each|
+      expect(each).to exist
+      expect(each).to have_correct_syntax
+    end
+  end
+
+  it "copies clearance locales to the host application" do
+    run_generator
+
+    locale = file("config/locales/clearance.en.yml")
+
+    expect(locale).to exist
+  end
+end

data/spec/mailers/clearance_mailer_spec.rb

@@ -1,35 +1,64 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe ClearanceMailer do
-  before do
-    @user  = create(:user)
-    @user.forgot_password!
-    @email = ClearanceMailer.change_password(@user)
-  end
+  it "is from DO_NOT_REPLY" do
+    user = create(:user)
+    user.forgot_password!
+
+    email = ClearanceMailer.change_password(user)
 
-  it 'is from DO_NOT_REPLY' do
-    expect(Clearance.configuration.mailer_sender).to match(/#{@email.from[0]}/i)
+    expect(Clearance.configuration.mailer_sender).to eq(email.from[0])
   end
 
-  it 'is sent to user' do
-    expect(@email.to.first).to match(/#{@user.email}/i)
+  it "is sent to user" do
+    user = create(:user)
+    user.forgot_password!
+
+    email = ClearanceMailer.change_password(user)
+
+    expect(email.to.first).to eq(user.email)
   end
 
-  it 'contains a link to edit the password' do
+  it "contains a link to edit the password" do
+    user = create(:user)
+    user.forgot_password!
     host = ActionMailer::Base.default_url_options[:host]
-    regexp = %r{http://#{host}/users/#{@user.id}/password/edit\?token=#{@user.confirmation_token}}
-    expect(@email.body.to_s).to match(regexp)
+    link = "http://#{host}/users/#{user.id}/password/edit" \
+      "?token=#{user.confirmation_token}"
+
+    email = ClearanceMailer.change_password(user)
+
+    expect(email.body.to_s).to include(link)
   end
 
-  it 'sets its subject' do
-    expect(@email.subject).to match(/Change your password/)
+  it "sets its subject" do
+    user = create(:user)
+    user.forgot_password!
+
+    email = ClearanceMailer.change_password(user)
+
+    expect(email.subject).to include("Change your password")
   end
 
-  it 'contains opening text in the body' do
-    expect(@email.body).to match(/a link to change your password/)
+  it "contains opening text in the body" do
+    user = create(:user)
+    user.forgot_password!
+
+    email = ClearanceMailer.change_password(user)
+
+    expect(email.body).to include(
+      I18n.t("clearance_mailer.change_password.opening")
+    )
   end
 
-  it 'contains closing text in the body' do
-    expect(@email.body).to match(/Your password has not been changed/)
+  it "contains closing text in the body" do
+    user = create(:user)
+    user.forgot_password!
+
+    email = ClearanceMailer.change_password(user)
+
+    expect(email.body.raw_source).to include(
+      I18n.t("clearance_mailer.change_password.closing")
+    )
   end
 end