Skip to content

Latest commit

 

History

History
179 lines (148 loc) · 8 KB

CHANGELOG.md

File metadata and controls

179 lines (148 loc) · 8 KB

Unreleased

  • removals
    • Devise::Mailer#scope_name and Devise::Mailer#resource are now protected methods instead of public.

4.2.0 - 2016-07-01

  • removals
    • Remove the deprecated Devise::ParameterSanitizer API from Devise 3. Please use the #permit and #sanitize methods over #for.
    • Remove the deprecated OmniAuth URL helpers. Use the fully qualified helpers (user_facebook_omniauth_authorize_path) over the scope based helpers ( user_omniauth_authorize_path(:facebook)).
    • Remove the Devise.bcrypt method, use Devise::Encryptor.digest instead.
    • Remove the Devise::Models::Confirmable#confirm! method, use confirm instead.
    • Remove the Devise::Models::Recoverable#reset_password! method, use reset_password instead.
    • Remove the Devise::Models::Recoverable#after_password_reset method.
  • bug fixes
    • Fix an ActionDispatch::IllegalStateError when testing controllers with Rails 5 rc 2(by @hamadata).
    • Use ActiveSupport.on_load hooks to include Devise on ActiveRecord and Mongoid, avoiding autoloading these constants too soon (by @lucasmazza, @rafaelfranca).
  • enhancements
    • Display the minimum password length on registrations/edit view (by @Yanchek99).
    • You can disable Devise's routes reloading on boot by through the reload_routes = false config. This can reduce the time taken to boot the application but it might trigger some errors if you application (mostly your controllers) requires that Devise mappings be loaded during boot time (by @sidonath).
    • Added Devise::Test::IntegrationHelpers to bypass the sign in process using Warden test API (by @lucasmazza).
    • Define inspect in Devise::Models::Authenticatable to help ensure password hashes aren't included in exceptions or otherwise accidentally serialized (by @tkrajcar).
    • Add missing support of Rails.application.config.action_controller.relative_url_root (by @kosdiamantis).
  • deprecations
    • Devise::TestHelpers is deprecated in favor of Devise::Test::ControllerHelpers (by @lucasmazza).
    • The sign_in test helper has changed to use keyword arguments when passing a scope. sign_in :admin, users(:alice) should be rewritten as sign_in users(:alice), scope: :admin (by @lucasmazza).
    • The option bypass of Devise::Controllers::SignInOut#sign_in method is deprecated in favor of Devise::Controllers::SignInOut#bypass_sign_in method (by @ulissesalmeida).

4.1.1 - 2016-05-15

  • bug fixes
    • Fix overwriting the remember_token when a valid one already exists (by @ralinchimev).

4.1.0

  • bug fixes
    • Fix race condition of sending the confirmation instructions e-mail using background jobs. Using the previous after_create callback, the e-mail can be sent before the record be committed on database, generating a ActiveRecord::NotFound error. Now the confirmation e-mail will be only sent after the database commit, using the after_commit callback. It may break your test suite on Rails 4 if you are testing the sent e-mails or enqueued jobs using transactional fixtures enabled or DatabaseCleaner with transaction strategy. You can easily fix your test suite using the gem test_after_commit. For example, put in your Gemfile:

        gem 'test_after_commit', :group => :test

      On Rails 5 after_commit callbacks are triggered even using transactional fixtures, then this fix will not break your test suite. If you are using DatabaseCleaner with the deletion or truncation strategies it may not break your tests. (by @allenwq)

    • Fix strategy checking in Lockable#unlock_strategy_enabled? for :none and :undefined strategies. (by @f3ndot)

  • features
    • Humanize authentication keys in failure flash message (by @byzg) When you are configuring the translations of devise.failure.invalid, the authentication_keys is translated now.
  • deprecations
    • Remove code supporting old session serialization format (by @fphilipe).
    • Now the email_regexp default uses a more permissive regex: /\A[^@\s]+@[^@\s]+\z/ (by @kimgb)
    • Now the strip_whitespace_keys default is [:email] (by @ulissesalmeida)
    • Now the reconfirmable default is true (by @ulissesalmeida)
    • Now the skip_session_storage default is [:http_auth] (by @ulissesalmeida)
    • Now the sign_out_via default is :delete (by @ulissesalmeida)
  • improvements
    • Avoids extra computation of friendly token for confirmation token (by @sbc100)

4.0.3 - 2016-05-15

  • bug fixes
    • Fix overwriting the remember_token when a valid one already exists (by @ralinchimev).

4.0.2 - 2016-05-02

  • bug fixes
    • Fix strategy checking in Lockable#unlock_strategy_enabled? for :none and :undefined strategies. (by @f3ndot)

4.0.1 - 2016-04-25

  • bug fixes
    • Fix the e-mail confirmation instructions send when a user updates the email address from nil. (by @lmduc)
    • Remove unnecessary attribute_will_change! call. (by @cadejscroggins)
    • Consistent permit! check. (by @ulissesalmeida)

4.0.0 - 2016-04-18

  • bug fixes

    • Fix the extend_remember_period configuration. When set to false it does not update the cookie expiration anymore.(by @ulissesalmeida)
  • deprecations

    • Added a warning of default value change in Devise 4.1 for users that uses the the default configuration of the following configurations: (by @ulissesalmeida)
      • strip_whitespace_keys - The default will be [:email].
      • skip_session_storage - The default will be [:http_auth].
      • sign_out_via - The default will be :delete.
      • reconfirmable - The default will be true.
      • email_regexp - The default will be /\A[^@\s]+@[^@\s]+\z/.
    • Removed deprecated argument of Devise::Models::Rememberable#remember_me! (by @ulissesalmeida)
    • Removed deprecated private method Devise::Controllers::Helpers#expire_session_data_after_sign_in! (by @bogdanvlviv)

4.0.0.rc2 - 2016-03-09

  • enhancements

    • Introduced DeviseController#set_flash_message! for conditional flash messages setting to reduce complexity.
    • rails g devise:install will fail if the app does not have a ORM configured (by @arjunsharma)
    • Support to Rails 5 versioned migrations added.
  • deprecations

    • omniauth routes are no longer defined with a wildcard :provider parameter, and provider specific routes are defined instead, so route helpers like user_omniauth_authorize_path(:github) are deprecated in favor of user_github_omniauth_authorize_path. You can still use omniauth_authorize_path(:user, :github) if you need to call the helpers dynamically.

4.0.0.rc1 - 2016-02-01

  • Support added to Rails 5 (by @twalpole).

  • Devise no longer supports Rails 3.2 and 4.0.

  • Devise no longer supports Ruby 1.9 and 2.0.

  • deprecations

    • The devise_parameter_sanitize API has changed: The for method was deprecated in favor of permit:

      def configure_permitted_parameters
        devise_parameter_sanitizer.for(:sign_up) << :subscribe_newsletter
        # Should become the following.
        devise_parameter_sanitizer.permit(:sign_up, keys: [:subscribe_newsletter])
      end

      The customization through instance methods on the sanitizer implementation should be done through it's initialize method:

      class User::ParameterSanitizer < Devise::ParameterSanitizer
        def sign_up
          default_params.permit(:username, :email)
        end
      end
      
      # The `sign_up` method can be a `permit` call on the sanitizer `initialize`.
      
      class User::ParameterSanitizer < Devise::ParameterSanitizer
        def initialize(*)
          super
          permit(:sign_up, keys: [:username, :email])
        end
      end

      You can check more examples and explanations on the README section and on the ParameterSanitizer docs.

Please check 3-stable for previous changes.