clearance 1.8.0 → 1.13.0

data/lib/clearance.rb

@@ -10,6 +10,8 @@ require 'clearance/password_strategies'
 require 'clearance/constraints'
 
 module Clearance
+  # @deprecated Use `Gem::Specification` API if you need to access Clearance's
+  #   Gem root.
   def self.root
     warn "#{Kernel.caller.first}: [DEPRECATION] `Clearance.root` is " +
       "deprecated and will be removed in the next major release. If you need " +

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

@@ -23,7 +23,7 @@ module Clearance
         if File.exist? "app/models/user.rb"
           inject_into_file(
             "app/models/user.rb",
-            "include Clearance::User\n\n",
+            "  include Clearance::User\n\n",
             after: "class User < ActiveRecord::Base\n"
           )
         else
@@ -61,7 +61,7 @@ module Clearance
           migration_template(
             "db/migrate/#{migration_name}",
             "db/migrate/#{migration_name}",
-            config
+            config.merge(migration_version: migration_version),
           )
         end
       end
@@ -101,7 +101,11 @@ module Clearance
       end
 
       def users_table_exists?
-        ActiveRecord::Base.connection.table_exists?(:users)
+        if ActiveRecord::Base.connection.respond_to?(:data_source_exists?)
+          ActiveRecord::Base.connection.data_source_exists?(:users)
+        else
+          ActiveRecord::Base.connection.table_exists?(:users)
+        end
       end
 
       def existing_users_columns
@@ -116,6 +120,12 @@ module Clearance
       def self.next_migration_number(dir)
         ActiveRecord::Generators::Base.next_migration_number(dir)
       end
+
+      def migration_version
+        if Rails.version >= "5.0.0"
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
     end
   end
 end

data/lib/generators/clearance/install/templates/db/migrate/add_clearance_to_users.rb

@@ -1,6 +1,6 @@
-class AddClearanceToUsers < ActiveRecord::Migration
+class AddClearanceToUsers < ActiveRecord::Migration<%= migration_version %>
   def self.up
-    change_table :users  do |t|
+    change_table :users do |t|
 <% config[:new_columns].values.each do |column| -%>
       <%= column %>
 <% end -%>
@@ -24,7 +24,7 @@ class AddClearanceToUsers < ActiveRecord::Migration
   def self.down
     change_table :users do |t|
 <% if config[:new_columns].any? -%>
-      t.remove <%= new_columns.keys.map { |column| ":#{column}" }.join(",") %>
+      t.remove <%= new_columns.keys.map { |column| ":#{column}" }.join(", ") %>
 <% end -%>
     end
   end

data/lib/generators/clearance/install/templates/db/migrate/create_users.rb

@@ -1,6 +1,6 @@
-class CreateUsers < ActiveRecord::Migration
+class CreateUsers < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :users  do |t|
+    create_table :users do |t|
       t.timestamps null: false
       t.string :email, null: false
       t.string :encrypted_password, limit: 128, null: false

data/lib/generators/clearance/routes/routes_generator.rb

@@ -9,6 +9,14 @@ module Clearance
         route(clearance_routes)
       end
 
+      def disable_clearance_internal_routes
+        inject_into_file(
+          "config/initializers/clearance.rb",
+          "  config.routes = false\n",
+          after: "Clearance.configure do |config|\n",
+        )
+      end
+
       private
 
       def clearance_routes
@@ -18,6 +26,21 @@ module Clearance
       def routes_file_path
         File.expand_path(find_in_source_paths('routes.rb'))
       end
+
+      def route(routing_code)
+        log :route, "all clearance routes"
+        sentinel = /\.routes\.draw do\s*\n/m
+
+        in_root do
+          inject_into_file(
+            "config/routes.rb",
+            routing_code,
+            after: sentinel,
+            verbose: false,
+            force: true,
+          )
+        end
+      end
     end
   end
 end

data/lib/generators/clearance/routes/templates/routes.rb

@@ -1,12 +1,12 @@
-resources :passwords, controller: 'clearance/passwords', only: [:create, :new]
-  resource :session, controller: 'clearance/sessions', only: [:create]
+  resources :passwords, controller: "clearance/passwords", only: [:create, :new]
+  resource :session, controller: "clearance/sessions", only: [:create]
 
-  resources :users, controller: 'clearance/users', only: [:create] do
+  resources :users, controller: "clearance/users", only: [:create] do
     resource :password,
-      controller: 'clearance/passwords',
+      controller: "clearance/passwords",
       only: [:create, :edit, :update]
   end
 
-  get '/sign_in' => 'clearance/sessions#new', as: 'sign_in'
-  delete '/sign_out' => 'clearance/sessions#destroy', as: 'sign_out'
-  get '/sign_up' => 'clearance/users#new', as: 'sign_up'
+  get "/sign_in" => "clearance/sessions#new", as: "sign_in"
+  delete "/sign_out" => "clearance/sessions#destroy", as: "sign_out"
+  get "/sign_up" => "clearance/users#new", as: "sign_up"

data/lib/generators/clearance/specs/templates/features/clearance/user_signs_out_spec.rb.tt

@@ -1,7 +1,7 @@
 require "<%= @helper_file %>"
 require "support/features/clearance_helpers"
 
-feature "User signs out" do
+RSpec.feature "User signs out" do
   scenario "signs out" do
     sign_in
     sign_out

data/lib/generators/clearance/specs/templates/features/clearance/visitor_resets_password_spec.rb.tt

@@ -1,8 +1,17 @@
 require "<%= @helper_file %>"
 require "support/features/clearance_helpers"
 
-feature "Visitor resets password" do
+RSpec.feature "Visitor resets password" do
   before { ActionMailer::Base.deliveries.clear }
+<% if defined?(ActiveJob) -%>
+
+  around do |example|
+    original_adapter = ActiveJob::Base.queue_adapter
+    ActiveJob::Base.queue_adapter = :inline
+    example.run
+    ActiveJob::Base.queue_adapter = original_adapter
+  end
+<% end -%>
 
   scenario "by navigating to the page" do
     visit sign_in_path
@@ -47,7 +56,8 @@ feature "Visitor resets password" do
     message = ActionMailer::Base.deliveries.any? do |email|
       email.to == [recipient] &&
         email.subject =~ /#{subject}/i &&
-        email.body =~ /#{body}/
+        email.html_part.body =~ /#{body}/ &&
+        email.text_part.body =~ /#{body}/
     end
 
     expect(message).to be

data/lib/generators/clearance/specs/templates/features/clearance/visitor_signs_in_spec.rb.tt

@@ -1,7 +1,7 @@
 require "<%= @helper_file %>"
 require "support/features/clearance_helpers"
 
-feature "Visitor signs in" do
+RSpec.feature "Visitor signs in" do
   scenario "with valid email and password" do
     create_user "user@example.com", "password"
     sign_in_with "user@example.com", "password"

data/lib/generators/clearance/specs/templates/features/clearance/visitor_signs_up_spec.rb.tt

@@ -1,7 +1,7 @@
 require "<%= @helper_file %>"
 require "support/features/clearance_helpers"
 
-feature "Visitor signs up" do
+RSpec.feature "Visitor signs up" do
   scenario "by navigating to the page" do
     visit sign_in_path
 

data/lib/generators/clearance/specs/templates/features/clearance/visitor_updates_password_spec.rb.tt

@@ -1,7 +1,7 @@
 require "<%= @helper_file %>"
 require "support/features/clearance_helpers"
 
-feature "Visitor updates password" do
+RSpec.feature "Visitor updates password" do
   scenario "with valid password" do
     user = user_with_reset_password
     update_password user, "newpassword"

data/spec/acceptance/clearance_installation_spec.rb

@@ -10,6 +10,7 @@ describe "Clearance Installation" do
 
   it "can successfully run specs" do
     app_name = "testapp"
+
     generate_test_app(app_name)
 
     Dir.chdir(app_name) do
@@ -28,7 +29,8 @@ describe "Clearance Installation" do
        --skip-git \
        --skip-javascript \
        --skip-sprockets \
-       --skip-keeps"
+       --skip-keeps \
+       --no-rc"
 
     FileUtils.rm_f("public/index.html")
     FileUtils.rm_f("app/views/layouts/application.html.erb")
@@ -70,6 +72,7 @@ describe "Clearance Installation" do
     end
 
     return_value = system("#{command} #{silencer}")
+
     expect(return_value).to eq true
   end
 end

data/spec/app_templates/config/initializers/clearance.rb

@@ -0,0 +1,2 @@
+Clearance.configure do |config|
+end

data/spec/app_templates/testapp/app/controllers/home_controller.rb

@@ -1,5 +1,9 @@
 class HomeController < ApplicationController
   def show
-    render text: "", layout: "application"
+    if Rails::VERSION::MAJOR >= 5
+      render html: "", layout: "application"
+    else
+      render text: "", layout: "application"
+    end
   end
 end

data/spec/app_templates/testapp/config/initializers/action_mailer.rb

@@ -1,3 +1 @@
-Rails.application.config.action_mailer.default_url_options = {
-  host: "localhost"
-}
+ActionMailer::Base.default_url_options[:host] = "localhost"

data/spec/clearance/controller_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Clearance::Controller, type: :controller do
+  controller(ActionController::Base) do
+    include Clearance::Controller
+  end
+
+  it "exposes no action methods" do
+    expect(controller.action_methods).to be_empty
+  end
+end

data/spec/clearance/rack_session_spec.rb

@@ -2,21 +2,21 @@ require 'spec_helper'
 
 describe Clearance::RackSession do
   it 'injects a clearance session into the environment' do
-    expected_session = 'the session'
-    allow(expected_session).to receive(:add_cookie_to_headers)
-    allow(Clearance::Session).to receive(:new).and_return(expected_session)
     headers = { 'X-Roaring-Lobster' => 'Red' }
-
     app = Rack::Builder.new do
       use Clearance::RackSession
       run lambda { |env| Rack::Response.new(env[:clearance], 200, headers).finish }
     end
 
     env = Rack::MockRequest.env_for('/')
+    expected_session = "the session"
+    allow(expected_session).to receive(:add_cookie_to_headers)
+    allow(Clearance::Session).to receive(:new).
+      with(env).
+      and_return(expected_session)
 
     response = Rack::MockResponse.new(*app.call(env))
 
-    expect(Clearance::Session).to have_received(:new).with(env)
     expect(response.body).to eq expected_session
     expect(expected_session).to have_received(:add_cookie_to_headers).
       with(hash_including(headers))

data/spec/clearance/testing/{helpers_spec.rb → controller_helpers_spec.rb}

@@ -1,20 +1,20 @@
-require 'spec_helper'
+require "spec_helper"
 
-describe Clearance::Testing::Helpers do
+describe Clearance::Testing::ControllerHelpers do
   class TestClass
-    include Clearance::Testing::Helpers
+    include Clearance::Testing::ControllerHelpers
 
     def initialize
-      @controller = Controller.new
-    end
-
-    class Controller
-      def sign_in(user); end
+      @request = Class.new do
+        def env
+          { clearance: Clearance::Session.new({}) }
+        end
+      end.new
     end
   end
 
-  describe '#sign_in' do
-    it 'creates an instance of the clearance user model with FactoryGirl' do
+  describe "#sign_in" do
+    it "creates an instance of the clearance user model with FactoryGirl" do
       MyUserModel = Class.new
       allow(FactoryGirl).to receive(:create)
       allow(Clearance.configuration).to receive(:user_model).
@@ -26,8 +26,8 @@ describe Clearance::Testing::Helpers do
     end
   end
 
-  describe '#sign_in_as' do
-    it 'returns the user if signed in successfully' do
+  describe "#sign_in_as" do
+    it "returns the user if signed in successfully" do
       user = build(:user)
 
       returned_user = TestClass.new.sign_in_as user

data/spec/clearance/testing/view_helpers_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Clearance::Testing::ViewHelpers do
+  describe "#sign_in" do
+    it "sets the signed in user to a new user object" do
+      user_model = Class.new
+      allow(Clearance.configuration).to receive(:user_model).
+        and_return(user_model)
+
+      view = test_view_class.new
+      view.sign_in
+
+      expect(view.current_user).to be_an_instance_of(user_model)
+    end
+  end
+
+  describe "#sign_in_as" do
+    it "sets the signed in user to the object provided" do
+      user = double("User")
+
+      view = test_view_class.new
+      view.sign_in_as(user)
+
+      expect(view.current_user).to eq user
+    end
+  end
+
+  def test_view_class
+    Class.new do
+      include Clearance::Testing::ViewHelpers
+
+      def view
+        @view ||= extend Clearance::Testing::ViewHelpers::CurrentUser
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -143,6 +143,15 @@ describe Clearance::Configuration do
     end
   end
 
+  describe "#user_parameter" do
+    it "returns the parameter key to use based on the user_model" do
+      Account = Class.new(ActiveRecord::Base)
+      Clearance.configure { |config| config.user_model = Account }
+
+      expect(Clearance.configuration.user_parameter).to eq :account
+    end
+  end
+
   describe '#user_id_parameter' do
     it 'returns the parameter key to use based on the user_model' do
       CustomUser = Class.new(ActiveRecord::Base)
@@ -162,4 +171,19 @@ describe Clearance::Configuration do
       expect(Clearance.configuration.routes_enabled?).to be false
     end
   end
+
+  describe "#reload_user_model" do
+    it "returns the user model class if one has already been configured" do
+      ConfiguredUser = Class.new
+      Clearance.configure { |config| config.user_model = ConfiguredUser }
+
+      expect(Clearance.configuration.reload_user_model).to eq ConfiguredUser
+    end
+
+    it "returns nil if the user_model has not been configured" do
+      Clearance.configuration = Clearance::Configuration.new
+
+      expect(Clearance.configuration.reload_user_model).to be_nil
+    end
+  end
 end

data/spec/controllers/apis_controller_spec.rb

@@ -3,10 +3,14 @@ require 'spec_helper'
 class ApisController < ActionController::Base
   include Clearance::Controller
 
-  before_filter :require_login
+  if respond_to?(:before_action)
+    before_action :require_login
+  else
+    before_filter :require_login
+  end
 
   def show
-    render text: 'response'
+    head :ok
   end
 end
 

data/spec/controllers/forgeries_controller_spec.rb

@@ -4,7 +4,12 @@ class ForgeriesController < ActionController::Base
   include Clearance::Controller
 
   protect_from_forgery
-  before_filter :require_login
+
+  if respond_to?(:before_action)
+    before_action :require_login
+  else
+    before_filter :require_login
+  end
 
   # This is off in test by default, but we need it for this test
   self.allow_forgery_protection = true

data/spec/controllers/passwords_controller_spec.rb

@@ -101,16 +101,6 @@ describe Clearance::PasswordsController do
         expect(user.reload.encrypted_password).not_to eq old_encrypted_password
       end
 
-      it "sets the remember token and clears the confirmation token" do
-        user = create(:user, :with_forgotten_password)
-
-        put :update, update_parameters(user, new_password: "my_new_password")
-
-        user.reload
-        expect(user.remember_token).not_to be_nil
-        expect(user.confirmation_token).to be_nil
-      end
-
       it "signs the user in and redirects" do
         user = create(:user, :with_forgotten_password)
 
@@ -121,7 +111,7 @@ describe Clearance::PasswordsController do
       end
     end
 
-    context "no password provided" do
+    context "password update fails" do
       it "does not update the password" do
         user = create(:user, :with_forgotten_password)
         old_encrypted_password = user.encrypted_password

data/spec/controllers/permissions_controller_spec.rb

@@ -3,14 +3,18 @@ require 'spec_helper'
 class PermissionsController < ActionController::Base
   include Clearance::Controller
 
-  before_filter :require_login, only: :show
+  if respond_to?(:before_action)
+    before_action :require_login, only: :show
+  else
+    before_filter :require_login, only: :show
+  end
 
   def new
-    render text: 'New page'
+    head :ok
   end
 
   def show
-    render text: 'Show page'
+    head :ok
   end
 end
 
@@ -54,6 +58,12 @@ describe PermissionsController do
 
       expect(subject).to deny_access(redirect: sign_in_url)
     end
+
+    it "denies access to show and display a flash message" do
+      get :show
+
+      expect(flash[:notice]).to match(/^Please sign in to continue/)
+    end
   end
 
   context 'when remember_token is blank' do

data/spec/controllers/sessions_controller_spec.rb

@@ -9,7 +9,7 @@ describe Clearance::SessionsController do
 
       it { should respond_with(:success) }
       it { should render_template(:new) }
-      it { should_not set_the_flash }
+      it { should_not set_flash }
     end
 
     context "when a user is signed in" do
@@ -19,7 +19,7 @@ describe Clearance::SessionsController do
       end
 
       it { should redirect_to(Clearance.configuration.redirect_url) }
-      it { should_not set_the_flash }
+      it { should_not set_flash }
     end
   end
 
@@ -45,7 +45,7 @@ describe Clearance::SessionsController do
       it { should redirect_to_url_after_create }
 
       it "sets the user in the clearance session" do
-        expect(controller.current_user).to eq @user
+        expect(request.env[:clearance].current_user).to eq @user
       end
 
       it "should not change the remember token" do
@@ -92,7 +92,7 @@ describe Clearance::SessionsController do
       end
 
       it "should unset the current user" do
-        expect(@controller.current_user).to be_nil
+        expect(request.env[:clearance].current_user).to be_nil
       end
     end
   end

data/spec/dummy/app/controllers/application_controller.rb

@@ -2,6 +2,10 @@ class ApplicationController < ActionController::Base
   include Clearance::Controller
 
   def show
-    render text: '', layout: 'application'
+    if Rails::VERSION::MAJOR >= 5
+      render html: "", layout: "application"
+    else
+      render text: "", layout: "application"
+    end
   end
 end

data/spec/dummy/application.rb

@@ -37,6 +37,10 @@ module Dummy
       config.paths.add "config/routes", with: "#{APP_ROOT}/config/routes.rb"
     end
 
+    if config.respond_to?(:active_job)
+      config.active_job.queue_adapter = :inline
+    end
+
     def require_environment!
       initialize!
     end

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

@@ -61,9 +61,7 @@ describe Clearance::Generators::InstallGenerator, :generator 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)
+        table_does_not_exist(:users)
 
         run_generator
         migration = migration_file("db/migrate/create_users.rb")
@@ -115,4 +113,18 @@ describe Clearance::Generators::InstallGenerator, :generator do
       end
     end
   end
+
+  def table_does_not_exist(name)
+    connection = ActiveRecord::Base.connection
+
+    if connection.respond_to?(:data_source_exists?)
+      allow(connection).to receive(:data_source_exists?).
+        with(name).
+        and_return(false)
+    else
+      allow(connection).to receive(:table_exists?).
+        with(name).
+        and_return(false)
+    end
+  end
 end

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

@@ -4,14 +4,18 @@ 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
+    provide_existing_initializer
 
     routes = file("config/routes.rb")
+    initializer = file("config/initializers/clearance.rb")
 
     run_generator
 
+    expect(initializer).to have_correct_syntax
+    expect(initializer).to contain("config.routes = false")
     expect(routes).to have_correct_syntax
     expect(routes).to contain(
-      "get '/sign_in' => 'clearance/sessions#new', as: 'sign_in'"
+      'get "/sign_in" => "clearance/sessions#new", as: "sign_in"'
     )
   end
 end

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

@@ -6,18 +6,19 @@ describe Clearance::Generators::ViewsGenerator, :generator 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
+      clearance_mailer/change_password.html.erb
+      clearance_mailer/change_password.text.erb
+      layouts/application.html.erb
+      passwords/create.html.erb
+      passwords/edit.html.erb
+      passwords/new.html.erb
+      sessions/_form.html.erb
+      sessions/new.html.erb
+      users/_form.html.erb
+      users/new.html.erb
     )
 
-    view_files = views.map { |view| file("app/views/#{view}.html.erb") }
+    view_files = views.map { |view| file("app/views/#{view}") }
 
     view_files.each do |each|
       expect(each).to exist

data/spec/helpers/helper_helpers_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe "Clearance RSpec helper spec configuration", type: :helper do
+  it "lets me use clearance's helper methods in helper specs" do
+    user = double("User")
+    sign_in_as(user)
+
+    expect(helper.current_user).to eq user
+  end
+end