clearance 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0472155cf20becdae95b0449996f13422cf8fd9f
-  data.tar.gz: 593e5208e89806394b03e9c0bac1c69f6836434b
+  metadata.gz: c1ce84cb7eaf277d03ef97bea09933416876f4c3
+  data.tar.gz: 622499f4174f3f22ceae7c50d1a6a586c73190f0
 SHA512:
-  metadata.gz: c855e609161a0adc70754a033596de44ffc49ded096b0f1e61bb541c670e1d75e82f518e73f5a0ed53d00d25b4763e12d2f9b494a23802c3428154304665097d
-  data.tar.gz: b243f157204f0256c3405e62c8e24219c5101e7852c3818d21e057c0405c36d02aa59dbfe4a3d7f27260eb802b2d1f9d5ff306135fbce1f78d6dcefb39d52cbb
+  metadata.gz: 374a634825b204e2c41fd78884226ef4684667225b6143170c85f1496eeee37e8494fd64c5bd39fecb972822912d234d3c9967f34e9b9b3a1bf62b1fea3621c9
+  data.tar.gz: f1be7061869311f8787b273ad65860c4231975b8e6df2305b0aa15d59c6d332a93b87ec5af88a4af3dfc730b87ab4439b63ffd1a4d74d821067b2f34a9550b1c

data/.gitignore

@@ -6,6 +6,7 @@
 .bundle
 db/*.sqlite3
 gemfiles/*.lock
+gemfiles/vendor/
 log/*.log
 pkg
 tmp/

data/Appraisals

@@ -7,14 +7,17 @@ end
 appraise 'rails40' do
   gem 'rails', '~> 4.0.13'
   gem 'test-unit'
+  gem 'mime-types', '~> 2.99'
 end
 
 appraise 'rails41' do
   gem 'rails', '~> 4.1.9'
+  gem 'mime-types', '~> 2.99'
 end
 
 appraise 'rails42' do
   gem 'rails', '~> 4.2.0'
+  gem 'mime-types', '~> 2.99'
 end
 
 if RUBY_VERSION >= "2.2.0"

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'appraisal', '~> 1.0'
+gem 'appraisal'
 gem 'ammeter'
 gem 'bundler', '~> 1.3'
 gem 'capybara', '>= 2.6.2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clearance (1.13.0)
+    clearance (1.14.0)
       bcrypt
       email_validator (~> 1.4)
       rails (>= 3.1)
@@ -9,36 +9,36 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.5)
-      actionview (= 4.2.5)
-      activesupport (= 4.2.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.5)
-      activesupport (= 4.2.5)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.5)
-      activesupport (= 4.2.5)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
       globalid (>= 0.3.0)
-    activemodel (4.2.5)
-      activesupport (= 4.2.5)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
       builder (~> 3.1)
-    activerecord (4.2.5)
-      activemodel (= 4.2.5)
-      activesupport (= 4.2.5)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
       arel (~> 6.0)
-    activesupport (4.2.5)
+    activesupport (4.2.6)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -49,31 +49,31 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
-    appraisal (1.0.3)
+    appraisal (2.1.0)
       bundler
       rake
       thor (>= 0.14.0)
     arel (6.0.3)
-    bcrypt (3.1.10)
+    bcrypt (3.1.11)
     builder (3.2.2)
-    capybara (2.6.2)
+    capybara (2.7.0)
       addressable
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
-    coderay (1.1.0)
+    coderay (1.1.1)
     concurrent-ruby (1.0.1)
-    database_cleaner (1.5.1)
+    database_cleaner (1.5.3)
     diff-lcs (1.2.5)
     email_validator (1.6.0)
       activemodel
     erubis (2.7.0)
-    factory_girl (4.5.0)
+    factory_girl (4.7.0)
       activesupport (>= 3.0.0)
-    factory_girl_rails (4.5.0)
-      factory_girl (~> 4.5.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
       railties (>= 3.0.0)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
@@ -81,13 +81,15 @@ GEM
     json (1.8.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
     method_source (0.8.2)
-    mime-types (2.99)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
     mini_portile2 (2.0.0)
-    minitest (5.8.3)
-    nokogiri (1.6.7.1)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
       mini_portile2 (~> 2.0.0.rc2)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -96,16 +98,16 @@ GEM
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.5)
-      actionmailer (= 4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
-      activemodel (= 4.2.5)
-      activerecord (= 4.2.5)
-      activesupport (= 4.2.5)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.5)
+      railties (= 4.2.6)
       sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
@@ -113,23 +115,23 @@ GEM
       activesupport (>= 4.2.0.beta, < 5.0)
       nokogiri (~> 1.6.0)
       rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.2)
+    rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.5)
-      actionpack (= 4.2.5)
-      activesupport (= 4.2.5)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.4.2)
-    rspec-core (3.4.1)
+    rake (11.1.2)
+    rspec-core (3.4.4)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-rails (3.4.0)
+    rspec-rails (3.4.2)
       actionpack (>= 3.0, < 4.3)
       activesupport (>= 3.0, < 4.3)
       railties (>= 3.0, < 4.3)
@@ -141,7 +143,7 @@ GEM
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
     slop (3.6.0)
-    sprockets (3.5.2)
+    sprockets (3.6.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.0.4)
@@ -151,7 +153,7 @@ GEM
     sqlite3 (1.3.11)
     thor (0.19.1)
     thread_safe (0.3.5)
-    timecop (0.8.0)
+    timecop (0.8.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     xpath (2.0.0)
@@ -162,7 +164,7 @@ PLATFORMS
 
 DEPENDENCIES
   ammeter
-  appraisal (~> 1.0)
+  appraisal
   bundler (~> 1.3)
   capybara (>= 2.6.2)
   clearance!

data/NEWS.md

@@ -3,6 +3,28 @@
 The noteworthy changes for each Clearance version are included here. For a
 complete changelog, see the git history for each version via the version links.
 
+## [1.14.0] - April 29, 2016
+
+### Added
+- `Clearance::BackDoor` now accepts a block, allowing the user for a test to be
+  looked up by a parameter other than `id` if you have overridden `to_param` for
+  the `User` model.
+
+### Fixed
+- We now correctly track the dirty state of `User#encrypted_password`, which
+  fixes custom validations on `User#password` (e.g. validating password length)
+  that were conditional on the password actually changing.
+- The `clearance:install` generator will now generate a `User` model that
+  inherits from `ApplicationRecord` if run on a Rails 5 app that doesn't already
+  have a `User` model.
+
+### Deprecated
+- `User#password_changing` is deprecated in favor of automatic dirty tracking on
+  `encrypted_password` and `password`. If you are calling this in your
+  application you should be able to remove it.
+
+[1.14.0]: https://github.com/thoughtbot/clearance/compare/v1.13.0...v1.14.0
+
 ## [1.13.0] - March 4, 2016
 
 ### Added

data/README.md

@@ -337,6 +337,20 @@ Usage:
 visit root_path(as: user)
 ```
 
+Additionally, if `User#to_param` is overridden, you can pass a block in
+order to override the default behavior:
+
+```ruby
+# config/environments/test.rb
+MyRailsApp::Application.configure do
+  # ...
+  config.middleware.use Clearance::BackDoor do |username|
+    Clearance.configuration.user_model.find_by(username: username)
+  end
+  # ...
+end
+```
+
 ### Ready Made Feature Specs
 
 If you're using RSpec, you can generate feature specs to help prevent

data/app/views/clearance_mailer/change_password.text.erb

@@ -1,4 +1,4 @@
-<%= t(".opening") %></p>
+<%= t(".opening") %>
 
 <%= edit_user_password_url(@user, token: @user.confirmation_token.html_safe) %>
 

data/gemfiles/rails32.gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", "~> 1.0"
 gem "ammeter"
 gem "bundler", "~> 1.3"
-gem "capybara", ">= 2.3"
+gem "capybara", ">= 2.6.2"
 gem "database_cleaner", "~> 1.0"
 gem "factory_girl_rails", "~> 4.2"
 gem "rspec-rails", "~> 3.1"

data/gemfiles/rails40.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 1.0"
+gem "appraisal"
 gem "ammeter"
 gem "bundler", "~> 1.3"
 gem "capybara", ">= 2.6.2"
@@ -15,5 +15,6 @@ gem "timecop", "~> 0.6"
 gem "pry", :require => false
 gem "rails", "~> 4.0.13"
 gem "test-unit"
+gem "mime-types", "~> 2.99"
 
 gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 1.0"
+gem "appraisal"
 gem "ammeter"
 gem "bundler", "~> 1.3"
 gem "capybara", ">= 2.6.2"
@@ -14,5 +14,6 @@ gem "sqlite3", "~> 1.3"
 gem "timecop", "~> 0.6"
 gem "pry", :require => false
 gem "rails", "~> 4.1.9"
+gem "mime-types", "~> 2.99"
 
 gemspec :path => "../"

data/gemfiles/rails42.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 1.0"
+gem "appraisal"
 gem "ammeter"
 gem "bundler", "~> 1.3"
 gem "capybara", ">= 2.6.2"
@@ -14,5 +14,6 @@ gem "sqlite3", "~> 1.3"
 gem "timecop", "~> 0.6"
 gem "pry", :require => false
 gem "rails", "~> 4.2.0"
+gem "mime-types", "~> 2.99"
 
 gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 1.0"
+gem "appraisal"
 gem "ammeter"
 gem "bundler", "~> 1.3"
 gem "capybara", ">= 2.6.2"

data/lib/clearance/back_door.rb

@@ -1,6 +1,7 @@
 module Clearance
   # Middleware which allows signing in by passing as=USER_ID in a query
-  # parameter.
+  # parameter. If `User#to_param` is overriden you may pass a block to
+  # override the default user lookup behaviour
   #
   # Designed to eliminate time in integration tests wasted by visiting and
   # submitting the sign in form.
@@ -14,12 +15,24 @@ module Clearance
   #     # ...
   #   end
   #
+  #   # or if `User#to_param` is overridden (to `username` for example):
+  #
+  #   # config/environments/test.rb
+  #   MyRailsApp::Application.configure do
+  #     # ...
+  #     config.middleware.use Clearance::BackDoor do |username|
+  #       User.find_by(username: username)
+  #     end
+  #     # ...
+  #   end
+  #
   # Usage:
   #
   #   visit new_feedback_path(as: user)
   class BackDoor
-    def initialize(app)
+    def initialize(app, &block)
       @app = app
+      @block = block
     end
 
     def call(env)
@@ -31,13 +44,22 @@ module Clearance
 
     # @api private
     def sign_in_through_the_back_door(env)
-      params = Rack::Utils.parse_query(env['QUERY_STRING'])
-      user_id = params['as']
+      params = Rack::Utils.parse_query(env["QUERY_STRING"])
+      user_param = params["as"]
 
-      if user_id.present?
-        user = Clearance.configuration.user_model.find(user_id)
+      if user_param.present?
+        user = find_user(user_param)
         env[:clearance].sign_in(user)
       end
     end
+
+    # @api private
+    def find_user(user_param)
+      if @block
+        @block.call(user_param)
+      else
+        Clearance.configuration.user_model.find(user_param)
+      end
+    end
   end
 end

data/lib/clearance/user.rb

@@ -47,10 +47,7 @@ module Clearance
   #     reset link.
   #
   # @!attribute password_changing
-  #   @return [String] Transient (non-persisted) attribute that is set to
-  #     `true` when {#update_password} is called. This value is read by
-  #     {#skip_password_validation?} to determine if password validations need
-  #     to be run.
+  #   @deprecated Dirty tracking is now handled automatically.
   #
   # @!attribute [r] password
   #   @return [String] Transient (non-persisted) attribute that is set when
@@ -103,12 +100,34 @@ module Clearance
     extend ActiveSupport::Concern
 
     included do
-      attr_accessor :password_changing
       attr_reader :password
 
       include Validations
       include Callbacks
       include password_strategy
+
+      def password=(value)
+        encrypted_password_will_change!
+        super
+      end
+
+      def password_changing
+        warn "#{Kernel.caller.first}: [DEPRECATION] " \
+          "The `password_changing` attribute is deprecated. Clearance uses " \
+          "the dirty state of the `encrypted_password` field to track this " \
+          "automatically."
+
+        @password_changing
+      end
+
+      def password_changing=(value)
+        warn "#{Kernel.caller.first}: [DEPRECATION] " \
+          "The `password_changing` attribute is deprecated. Clearance uses " \
+          "the dirty state of the `encrypted_password` field to track this " \
+          "automatically."
+
+        @password_changing = value
+      end
     end
 
     # @api private
@@ -203,7 +222,6 @@ module Clearance
     #
     # @return [Boolean] Was the save successful?
     def update_password(new_password)
-      self.password_changing = true
       self.password = new_password
 
       if valid?
@@ -245,7 +263,8 @@ module Clearance
     #
     # @return [Boolean]
     def skip_password_validation?
-      password_optional? || (encrypted_password.present? && !password_changing)
+      password_optional? ||
+        (encrypted_password.present? && !encrypted_password_changed?)
     end
 
     # Sets the {#confirmation_token} on the instance to a new value generated by
@@ -259,7 +278,7 @@ module Clearance
 
     # Sets the {#remember_token} on the instance to a new value generated by
     # {Token.new}. The change is not automatically persisted. If you would like
-    # to generate and sace in a single method call, use
+    # to generate and save in a single method call, use
     # {#reset_remember_token!}.
     #
     # @return [String] The new remember token

data/lib/clearance/version.rb

@@ -1,3 +1,3 @@
 module Clearance
-  VERSION = "1.13.0".freeze
+  VERSION = "1.14.0".freeze
 end

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

@@ -24,10 +24,11 @@ module Clearance
           inject_into_file(
             "app/models/user.rb",
             "  include Clearance::User\n\n",
-            after: "class User < ActiveRecord::Base\n"
+            after: "class User < ",
           )
         else
-          copy_file 'user.rb', 'app/models/user.rb'
+          @inherit_from = models_inherit_from
+          template("user.rb.erb", "app/models/user.rb")
         end
       end
 
@@ -126,6 +127,14 @@ module Clearance
           "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
         end
       end
+
+      def models_inherit_from
+        if Rails.version >= "5.0.0"
+          "ApplicationRecord"
+        else
+          "ActiveRecord::Base"
+        end
+      end
     end
   end
 end

data/lib/generators/clearance/install/templates/user.rb.erb

@@ -0,0 +1,3 @@
+class User < <%= @inherit_from %>
+  include Clearance::User
+end

data/spec/clearance/back_door_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Clearance::BackDoor do
-  it 'signs in as a given user' do
-    user_id = '123'
+  it "signs in as a given user" do
+    user_id = "123"
     user = double("user")
     allow(User).to receive(:find).with(user_id).and_return(user)
     env = env_for_user_id(user_id)
@@ -14,7 +14,7 @@ describe Clearance::BackDoor do
     expect(result).to eq mock_app.call(env)
   end
 
-  it 'delegates directly without a user' do
+  it "delegates directly without a user" do
     env = env_without_user_id
     back_door = Clearance::BackDoor.new(mock_app)
 
@@ -24,8 +24,22 @@ describe Clearance::BackDoor do
     expect(result).to eq mock_app.call(env)
   end
 
+  it "can set the user via a block" do
+    env = env_for_username("foo")
+    user = double("user")
+    allow(User).to receive(:find_by).with(username: "foo").and_return(user)
+    back_door = Clearance::BackDoor.new(mock_app) do |username|
+      User.find_by(username: username)
+    end
+
+    result = back_door.call(env)
+
+    expect(env[:clearance]).to have_received(:sign_in).with(user)
+    expect(result).to eq mock_app.call(env)
+  end
+
   def env_without_user_id
-    env_for_user_id('')
+    env_for_user_id("")
   end
 
   def env_for_user_id(user_id)
@@ -33,7 +47,12 @@ describe Clearance::BackDoor do
     Rack::MockRequest.env_for("/?as=#{user_id}").merge(clearance: clearance)
   end
 
+  def env_for_username(username)
+    clearance = double("clearance", sign_in: true)
+    Rack::MockRequest.env_for("/?as=#{username}").merge(clearance: clearance)
+  end
+
   def mock_app
-    lambda { |env| [200, {}, ['okay']] }
+    lambda { |env| [200, {}, ["okay"]] }
   end
 end

data/spec/clearance/session_spec.rb

@@ -32,12 +32,12 @@ describe Clearance::Session do
 
   context "with a custom cookie name" do
     it "sets a custom cookie name in the header" do
-      Clearance.configuration.cookie_domain = "custom_token"
+      Clearance.configuration.cookie_name = "custom_cookie_name"
 
       session.sign_in user
       session.add_cookie_to_headers(headers)
 
-      expect(headers["Set-Cookie"]).to match(/custom_token/)
+      expect(headers["Set-Cookie"]).to match(/custom_cookie_name=.+;/)
     end
 
     after { restore_default_config }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clearance
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Dan Croak
@@ -25,7 +25,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -152,7 +152,7 @@ files:
 - lib/generators/clearance/install/templates/clearance.rb
 - lib/generators/clearance/install/templates/db/migrate/add_clearance_to_users.rb
 - lib/generators/clearance/install/templates/db/migrate/create_users.rb
-- lib/generators/clearance/install/templates/user.rb
+- lib/generators/clearance/install/templates/user.rb.erb
 - lib/generators/clearance/routes/routes_generator.rb
 - lib/generators/clearance/routes/templates/routes.rb
 - lib/generators/clearance/specs/USAGE

data/lib/generators/clearance/install/templates/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-  include Clearance::User
-end