sorcery 0.9.0 → 0.10.0

data/README.md

@@ -1,95 +1,96 @@
-[![Build Status](https://travis-ci.org/NoamB/sorcery.svg?branch=master)](https://travis-ci.org/NoamB/sorcery)
-[![Code Climate](https://codeclimate.com/github/NoamB/sorcery.png)](https://codeclimate.com/github/NoamB/sorcery)
-[![Inline docs](http://inch-ci.org/github/NoamB/sorcery.png?branch=master)](http://inch-ci.org/github/NoamB/sorcery)
+# Sorcery: Magical Authentication
 
-# sorcery
-Magical Authentication for Rails 3 and 4. Supports ActiveRecord,
-DataMapper, Mongoid and MongoMapper.
+[![Gem Version](https://badge.fury.io/rb/sorcery.svg)](https://rubygems.org/gems/sorcery)
+[![Gem Downloads](https://img.shields.io/gem/dt/sorcery.svg)](https://rubygems.org/gems/sorcery)
+[![Build Status](https://travis-ci.org/Sorcery/sorcery.svg?branch=master)](https://travis-ci.org/Sorcery/sorcery)
+[![Code Climate](https://codeclimate.com/github/Sorcery/sorcery.svg)](https://codeclimate.com/github/Sorcery/sorcery)
+[![Inline docs](http://inch-ci.org/github/Sorcery/sorcery.svg?branch=master)](http://inch-ci.org/github/Sorcery/sorcery)
+[![Join the chat at https://gitter.im/Sorcery/sorcery](https://badges.gitter.im/join_chat.svg)](https://gitter.im/Sorcery/sorcery?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Inspired by restful_authentication, Authlogic and Devise. Crypto code taken
-almost unchanged from Authlogic. OAuth code inspired by OmniAuth and Ryan
-Bates's railscasts about it.
+Magical Authentication for Rails. Supports ActiveRecord, DataMapper, Mongoid and MongoMapper.
 
-**What's happening now?** We are working on 1.0 version, which will include some API-breaking changes. It should be released about April 2015.
-Until then we'll continue releasing `0.9.x` version with bug fixed.
+Inspired by Restful Authentication, Authlogic and Devise. Crypto code taken almost unchanged from Authlogic. OAuth code inspired by OmniAuth and Ryan Bates's Railscast about it.
 
-**Rails 4 status:** [Sorcery 0.9.0](http://rubygems.org/gems/sorcery/versions/0.9.0) is fully tested and ready for Rails 4.0, 4.1 and 4.2.
-**Mongoid status:** Version 0.9.0 works with Mongoid 4.
+### Philosophy
 
-https://github.com/NoamB/sorcery/wiki/Simple-Password-Authentication
+Sorcery is a stripped-down, bare-bones authentication library, with which you can write your own authentication flow. It was built with a few goals in mind:
 
-## Philosophy
-
-Sorcery is a stripped-down, bare-bones authentication library, with which you
-can write your own authentication flow. It was built with a few goals in mind:
-
-*   Less is more - less than 20 public methods to remember for the entire
-    feature-set make the lib easy to 'get'.
-*   No built-in or generated code - use the library's methods inside *your
-    own* MVC structures, and don't fight to fix someone else's.
-*   Magic yes, Voodoo no - the lib should be easy to hack for most developers.
-*   Configuration over Confusion - Centralized (1 file), Simple & short
-    configuration as possible, not drowning in syntactic sugar.
-*   Keep MVC cleanly separated - DB is for models, sessions are for
-    controllers. Models stay unaware of sessions.
-
-
-Hopefully, I've achieved this. If not, let me know.
+- Less is more - less than 20 public methods to remember for the entire feature-set make the lib easy to 'get'.
+- No built-in or generated code - use the library's methods inside *your own* MVC structures, and don't fight to fix someone else's.
+- Magic yes, Voodoo no - the lib should be easy to hack for most developers.
+- Configuration over Confusion - Centralized (1 file), Simple & short configuration as possible, not drowning in syntactic sugar.
+- Keep MVC cleanly separated - DB is for models, sessions are for controllers. Models stay unaware of sessions.
 
 ## Useful Links
 
-[Documentation](http://rubydoc.info/gems/sorcery) |
-[Railscast](http://railscasts.com/episodes/283-authentication-with-sorcery) | [Simple tutorial](https://github.com/NoamB/sorcery/wiki/Simple-Password-Authentication) | [Example Rails 3 app](https://github.com/NoamB/sorcery-example-app)
+- [Documentation](http://rubydoc.info/gems/sorcery)
+- [Railscast](http://railscasts.com/episodes/283-authentication-with-sorcery)
+- [Simple tutorial](https://github.com/Sorcery/sorcery/wiki/Simple-Password-Authentication)
+- [Example Rails app](https://github.com/Sorcery/sorcery-example-app)
 
-Check out the tutorials in the [Wiki](https://github.com/NoamB/sorcery/wiki) for more!
+Check out the tutorials in the [wiki](https://github.com/Sorcery/sorcery/wiki) for more:
+
+- [DataMapper Support](https://github.com/Sorcery/sorcery/wiki/DataMapper-Support)
+- [DelayedJob Integration](https://github.com/Sorcery/sorcery/wiki/DelayedJob-Integration)
+- [Simple Password Authentication](https://github.com/Sorcery/sorcery/wiki/Simple-Password-Authentication)
+- [Single Table Inheritance Support](https://github.com/Sorcery/sorcery/wiki/Single-Table-Inheritance-Support)
+- [Upgrading](https://github.com/Sorcery/sorcery/wiki/Upgrading)
 
 ## API Summary
 
 Below is a summary of the library methods. Most method names are self
 explaining and the rest are commented:
 
+### Core
 
-### core
 ```ruby
-require_login # this is a before filter
+require_login # This is a before action
 login(email, password, remember_me = false)
-auto_login(user)# login without credentials
+auto_login(user) # Login without credentials
 logout
-logged_in?      # available to view
-current_user    # available to view
-redirect_back_or_to # used when a user tries to access a page while logged out, is asked to login, and we want to return him back to the page he originally wanted.
-@user.external? # external users, such as facebook/twitter etc.
+logged_in? # Available in views
+current_user # Available in views
+redirect_back_or_to # Use when a user tries to access a page while logged out, is asked to login, and we want to return him back to the page he originally wanted
+@user.external? # Users who signed up using Facebook, Twitter, etc.
+@user.active_for_authentication? # Add this method to define behaviour that will prevent selected users from signing in
+@user.valid_password?('secret') # Compares 'secret' with the actual user's password, returns true if they match
 User.authenticates_with_sorcery!
 ```
 
-### http basic auth
+### HTTP Basic Auth
+
 ```ruby
-require_login_from_http_basic # this is a before filter
+require_login_from_http_basic # This is a before action
 ```
 
-### external
+### External
+
 ```ruby
-login_at(provider) # sends the user to an external service (twitter etc.) to authenticate.
-login_from(provider) # tries to login from the external provider's callback.
-create_from(provider) # create the user in the local app db.
+login_at(provider) # Sends the user to an external service (Facebook, Twitter, etc.) to authenticate
+login_from(provider) # Tries to login from the external provider's callback
+create_from(provider) # Create the user in the local app database
 ```
 
-### remember me
+### Remember Me
+
 ```ruby
-auto_login(user, should_remember=false)  # login without credentials, optional remember_me
+auto_login(user, should_remember = false) # Login without credentials, optional remember_me
 remember_me!
 forget_me!
+force_forget_me! # Forgets all sessions by clearing the token, even if remember_me_token_persist_globally is set to true
 ```
 
-### reset password
+### Reset Password
+
 ```ruby
 User.load_from_reset_password_token(token)
-@user.generate_reset_password_token! # if you want to send the email by youself
-@user.deliver_reset_password_instructions! # generates the token and sends the email
+@user.generate_reset_password_token! # Use if you want to send the email by yourself
+@user.deliver_reset_password_instructions! # Generates the token and sends the email
 @user.change_password!(new_password)
 ```
 
-### user activation
+### User Activation
+
 ```ruby
 User.load_from_activation_token(token)
 @user.setup_activation
@@ -100,272 +101,124 @@ Please see the tutorials in the github wiki for detailed usage information.
 
 ## Installation
 
-If using bundler, first add 'sorcery' to your Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
-gem "sorcery"
+gem 'sorcery'
 ```
 
-And run
+And then execute:
 
-```ruby
-bundle install
-```
+    $ bundle
 
-Otherwise simply
+Or install it yourself as:
 
-```ruby
-gem install sorcery
-```
+    $ gem install sorcery
 
-## Rails configuration
+## Configuration
 
-```bash
-rails generate sorcery:install
-```
+Run the following command to generate the core migration file, the initializer file and the
+`User` model class.
 
-This will generate the core migration file, the initializer file and the
-'User' model class.
+    $ rails generate sorcery:install
 
-```bash
-rails generate sorcery:install remember_me reset_password
-```
+Run the following command generate the migrations files for remember_me and reset_password submodules and will create the initializer file (and add submodules to it), and create the `User` model class.
 
-This will generate the migrations files for remember_me and reset_password
-submodules and will create the initializer file (and add submodules to it),
-and create the 'User' model class.
+    $ rails generate sorcery:install remember_me reset_password
 
-```bash
-rails generate sorcery:install --model Person
-```
+Run the following command to generate the core migration file, the initializer and change the model class (in the initializer and migration files) to the class `Person` (and its pluralized version, 'people')
 
-This will generate the core migration file, the initializer and change the
-model class (in the initializer and migration files) to the class 'Person'
-(and its pluralized version, 'people')
+    $ rails generate sorcery:install --model Person
 
-```bash
-rails generate sorcery:install http_basic_auth external remember_me --only-submodules
-```
+Run the following command to generate only the migration files for the specified submodules and will add them to the initializer file.
 
-This will generate only the migration files for the specified submodules and
-will add them to the initializer file.
+    $ rails generate sorcery:install http_basic_auth external remember_me --only-submodules
 
 Inside the initializer, the comments will tell you what each setting does.
 
-## DelayedJob Integration
-
-By default emails are sent synchronously. You can send them asynchronously by
-using the [delayed_job gem](https://github.com/collectiveidea/delayed_job).
-
-After implementing the `delayed_job` into your project add the code below at
-the end of the `config/initializers/sorcery.rb` file. After that all emails
-will be sent asynchronously.
-
-```ruby
-module Sorcery
-  module Model
-    module InstanceMethods
-      def generic_send_email(method, mailer)
-        config = sorcery_config
-        mail = config.send(mailer).delay.send(config.send(method), self)
-      end
-    end
-  end
-end
-```
-
-Sidekiq and Resque integrations are coming soon.
-
-## Single Table Inheritance (STI) Support
-STI is supported via a single setting in config/initializers/sorcery.rb.
-
-## Full Features List by module
-
-**Core** (see [lib/sorcery/model.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model.rb) and
-[lib/sorcery/controller.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/controller.rb)):
-
-*   login/logout, optional return user to requested url on login, configurable
-    redirect for non-logged-in users.
-*   password encryption, algorithms: bcrypt(default), md5, sha1, sha256,
-    sha512, aes256, custom(yours!), none. Configurable stretches and salt.
-*   configurable attribute names for username, password and email.
-*   allow multiple fields to serve as username.
-
-
-**User Activation** (see [lib/sorcery/model/submodules/user_activation.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model/submodules/user_activation.rb)):
-
-*   User activation by email with optional success email.
-*   configurable attribute names.
-*   configurable mailer, method name, and attribute name.
-*   configurable temporary token expiration.
-*   Optionally prevent non-active users to login.
+## Full Features List by Module
 
+**Core** (see [lib/sorcery/model.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model.rb) and [lib/sorcery/controller.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/controller.rb)):
 
-**Reset Password** (see [lib/sorcery/model/submodules/reset_password.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model/submodules/reset_password.rb)):
+- Login / logout, optional return user to requested url on login, configurable redirect for non-logged-in users.
+- Password encryption, algorithms: bcrypt (default), MD5, SHA-1, SHA-256, SHA-512, AES or custom. Configurable stretches and salt.
+- Configurable attribute names for username, password and email.
+- Allow multiple fields to serve as username.
 
-*   Reset password with email verification.
-*   configurable mailer, method name, and attribute name.
-*   configurable temporary token expiration.
-*   configurable time between emails (hammering protection).
+**User Activation** (see [lib/sorcery/model/submodules/user_activation.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model/submodules/user_activation.rb)):
 
+- User activation by email with optional success email
+- Configurable attribute names
+- Configurable mailer, method name, and attribute name
+- Configurable temporary token expiration
+- Optionally prevent non-active users to login
 
-**Remember Me** (see [lib/sorcery/model/submodules/remember_me.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model/submodules/remember_me.rb)):
+**Reset Password** (see [lib/sorcery/model/submodules/reset_password.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model/submodules/reset_password.rb)):
 
-*   Remember me with configurable expiration.
-*   configurable attribute names.
+- Reset password with email verification
+- Configurable mailer, method name, and attribute name
+- Configurable temporary token expiration
+- Configurable time between emails (hammering protection)
 
+**Remember Me** (see [lib/sorcery/model/submodules/remember_me.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model/submodules/remember_me.rb)):
 
-**Session Timeout** (see [lib/sorcery/controller/submodules/session_timeout.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/controller/submodules/session_timeout.rb)):
+- Remember me with configurable expiration
+- Configurable attribute names
+- Configurable to persist globally (supporting multiple browsers at the same time), or starting anew after each login
 
-*   Configurable session timeout.
-*   Optionally session timeout will be calculated from last user action.
+**Session Timeout** (see [lib/sorcery/controller/submodules/session_timeout.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/controller/submodules/session_timeout.rb)):
 
+- Configurable session timeout
+- Optionally session timeout will be calculated from last user action
 
-**Brute Force Protection** (see [lib/sorcery/model/submodules/brute_force_protection.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model/submodules/brute_force_protection.rb)):
+**Brute Force Protection** (see [lib/sorcery/model/submodules/brute_force_protection.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model/submodules/brute_force_protection.rb)):
 
-*   Brute force login hammering protection.
-*   configurable logins before lock and lock duration.
+- Brute force login hammering protection
+- configurable logins before lock and lock duration
 
+**Basic HTTP Authentication** (see [lib/sorcery/controller/submodules/http_basic_auth.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/controller/submodules/http_basic_auth.rb)):
 
-**Basic HTTP Authentication** (see [lib/sorcery/controller/submodules/http_basic_auth.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/controller/submodules/http_basic_auth.rb)):
+- A before action for requesting authentication with HTTP Basic
+- Automatic login from HTTP Basic
+- Automatic login is disabled if session key changed
 
-*   A before filter for requesting authentication with HTTP Basic.
-*   automatic login from HTTP Basic.
-*   automatic login is disabled if session key changed.
+**Activity Logging** (see [lib/sorcery/model/submodules/activity_logging.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/model/submodules/activity_logging.rb)):
 
+- Automatic logging of last login, last logout, last activity time and IP address for last login
+- Configurable timeout by which to decide whether to include a user in the list of logged in users
 
-**Activity Logging** (see [lib/sorcery/model/submodules/activity_logging.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/model/submodules/activity_logging.rb)):
+**External** (see [lib/sorcery/controller/submodules/external.rb](https://github.com/Sorcery/sorcery/blob/master/lib/sorcery/controller/submodules/external.rb)):
 
-*   automatic logging of last login, last logout, last activity time and IP
-    address for last login.
-*   an easy method of collecting the list of currently logged in users.
-*   configurable timeout by which to decide whether to include a user in the
-    list of logged in users.
+- OAuth1 and OAuth2 support (currently: Twitter, Facebook, Github, Google, Heroku, LinkedIn, VK, LiveID, Xing, Salesforce)
+- Configurable database column names
+- Authentications table
 
+## Planned Features
 
-**External** (see [lib/sorcery/controller/submodules/external.rb](https://github.com/NoamB/sorcery/blob/master/lib/sorcery/controller/submodules/external.rb)):
+- Passing a block to encrypt, allowing the developer to define his own mix of salting and encrypting
+- Forgot username, maybe as part of the reset_password module
+- Scoping logins (to a subdomain or another arbitrary field)
+- Allowing storing the salt and encrypted password in the same DB field for extra security
+- Other reset password strategies (security questions?)
+- Other brute force protection strategies (captcha)
 
-*   OAuth1 and OAuth2 support (currently: Twitter, Facebook, Github, Google, Heroku,
-    LinkedIn, VK, LiveID, Xing, and Salesforce)
-*   configurable db field names and authentications table.
+Have an idea? Let us know, and it might get into the gem!
 
+## Contributing
 
-## Next Planned Features
-
-I've got some thoughts which include (unordered):
-
-*   Passing a block to encrypt, allowing the developer to define his own mix
-    of salting and encrypting
-*   Forgot username, maybe as part of the reset_password module
-*   Scoping logins (to a subdomain or another arbitrary field)
-*   Allowing storing the salt and crypted password in the same DB field for
-    extra security
-*   Other reset password strategies (security questions?)
-*   Other brute force protection strategies (captcha)
-
-
-Have an idea? Let me know, and it might get into the gem!
-
-## Backward compatibility
-
-While the lib is young and evolving fast I'm breaking backward compatibility
-quite often. I'm constantly finding better ways to do things and throwing away
-old ways. To let you know when things are changing in a non-compatible way,
-I'm bumping the minor version of the gem. The patch version changes are
-backward compatible.
-
-In short, an app that works with x.3.1 should be able to upgrade to x.3.2 with
-no code changes. The same cannot be said about upgrading to x.4.0 and above,
-however.
-
-## DataMapper Support
-
-Important notes:
-
-*   Expected to work with DM adapters: dm-mysql-adapter,
-    dm-redis-adapter.
-*   Submodules DM adapter dependent: activity_logging (dm-mysql-adapter)
-*   Usage: include DataMapper::Resource in user model, follow sorcery
-    instructions (remember to add property id, validators and accessor
-attributes such as password and password_confirmation)
-*   Option downcase__username_before_authenticating and dm-mysql,
-    http://datamapper.lighthouseapp.com/projects/20609/tickets/1105-add-support-for-definingchanging-default-collation
-
-## Upgrading
-
-Important notes while upgrading:
-
-*   If you are upgrading from <= **0.8.6** and you use Sorcery model methods in your app,
-    you might need to change them from `user.method` to `user.sorcery_adapter.method` and from
-    `User.method` to `User.sorcery_adapter_method`
-
-*   If you are upgrading from <= **0.8.5** and you're using Sorcery test helpers,
-    you need to change the way you include them to following code:
-
-    ```ruby
-    RSpec.configure do |config|
-      config.include Sorcery::TestHelpers::Rails::Controller, type: :controller
-      config.include Sorcery::TestHelpers::Rails::Integration, type: :feature
-    end
-    ```
-
-*   If are upgrading to **0.8.2** and use activity_logging feature with
-    ActiveRecord, you will have to add a new column
-    `last_login_from_ip_address`
-    [#465](https://github.com/NoamB/sorcery/issues/465)
-*   Sinatra support existed until **v0.7.0** (including), but was dropped
-    later due to being a maintenance nightmare.
-*   If upgrading from <= **0.6.1 to >= **0.7.0** you need to change
-    'username
-    _attribute_name' to 'username_attribute_names' in initializer.
-*   If upgrading from <= **v0.5.1** to >= **v0.5.2** you need to explicitly
-    set your user_class model in the initializer file.
-
-    ```ruby
-    # This line must come after the 'user config' block.
-    config.user_class = User
-    ```
-
-
-## Contributing to sorcery
-
-Your feedback is very welcome and will make this gem much much better for you,
-me and everyone else. Besides feedback on code, features, suggestions and bug
-reports, you may want to actually make an impact on the code. For this:
-
-*   Fork it.
-*   Fix it.
-*   Test it.
-*   Commit it.
-*   Send me a pull request so I'll... Pull it.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/Sorcery/sorcery.
 
 If you feel sorcery has made your life easier, and you would like to express
-your thanks via a donation, my paypal email is in the contact details.
+your thanks via a donation, my PayPal email is in the contact details.
 
 ## Contact
 
 Feel free to ask questions using these contact details:
 
-#### Noam Ben-Ari
-
-email: nbenari@gmail.com ( also for paypal )
-
-twitter: @nbenari
-
-#### Kir Shatrov
-
-email: shatrov@me.com
-
-twitter: @Kiiiir
-
-#### Grzegorz Witek
-
-email: arnvald.to@gmail.com
-
-twitter: @arnvald
+- Noam Ben-Ari: [nbenari@gmail.com](mailto:nbenari@gmail.com) (also PayPal), [Twitter](https://twitter.com/nbenari)
+- Kir Shatrov: [shatrov@me.com](mailto:shatrov@me.com), [Twitter](https://twitter.com/Kiiiir)
+- Grzegorz Witek: [arnvald.to@gmail.com](mailto:arnvald.to@gmail.com), [Twitter](https://twitter.com/arnvald)
 
-## Copyright
+## License
 
-Copyright (c) 2010-2014 Noam Ben Ari (nbenari@gmail.com). See LICENSE.txt for
-further details.
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/{mongoid-rails40.gemfile → active_record-rails42.gemfile}

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 4.0.0'
-
-gem 'mongoid', '~> 4.0.0'
 gem 'sqlite3', platform: :mri
 gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'rails', '~> 4.2.0'
 
 gemspec path: '..'

data/lib/generators/sorcery/helpers.rb

@@ -4,16 +4,16 @@ module Sorcery
       private
 
       def sorcery_config_path
-        "config/initializers/sorcery.rb"
+        'config/initializers/sorcery.rb'
       end
 
       # Either return the model passed in a classified form or return the default "User".
       def model_class_name
-        options[:model] ? options[:model].classify : "User"
+        options[:model] ? options[:model].classify : 'User'
       end
 
       def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
       end
 
       def file_path
@@ -33,7 +33,7 @@ module Sorcery
           [namespace.to_s] + [model_class_name]
         else
           [model_class_name]
-        end.join("::")
+        end.join('::')
       end
     end
   end

data/lib/generators/sorcery/install_generator.rb

@@ -9,36 +9,35 @@ module Sorcery
 
       source_root File.expand_path('../templates', __FILE__)
 
-      argument :submodules, :optional => true, :type => :array, :banner => "submodules"
+      argument :submodules, optional: true, type: :array, banner: 'submodules'
 
-      class_option :model, :optional => true, :type => :string, :banner => "model",
-                   :desc => "Specify the model class name if you will use anything other than 'User'"
+      class_option :model, optional: true, type: :string, banner: 'model',
+                           desc: "Specify the model class name if you will use anything other than 'User'"
 
-      class_option :migrations, :optional => true, :type => :boolean, :banner => "migrations",
-                   :desc => "[DEPRECATED] Please use --only-submodules option instead"
-
-      class_option :only_submodules, :optional => true, :type => :boolean, :banner => "only-submodules",
-                   :desc => "Specify if you want to add submodules to an existing model\n\t\t\t     # (will generate migrations files, and add submodules to config file)"
+      class_option :migrations, optional: true, type: :boolean, banner: 'migrations',
+                                desc: '[DEPRECATED] Please use --only-submodules option instead'
 
+      class_option :only_submodules, optional: true, type: :boolean, banner: 'only-submodules',
+                                     desc: "Specify if you want to add submodules to an existing model\n\t\t\t     # (will generate migrations files, and add submodules to config file)"
 
       def check_deprecated_options
         if options[:migrations]
-          warn("[DEPRECATED] `--migrations` option is deprecated, please use `--only-submodules` instead")
+          warn('[DEPRECATED] `--migrations` option is deprecated, please use `--only-submodules` instead')
         end
       end
 
       # Copy the initializer file to config/initializers folder.
       def copy_initializer_file
-        template "initializer.rb", sorcery_config_path unless only_submodules?
+        template 'initializer.rb', sorcery_config_path unless only_submodules?
       end
 
       def configure_initializer_file
         # Add submodules to the initializer file.
         if submodules
-          submodule_names = submodules.collect{ |submodule| ':' + submodule }
+          submodule_names = submodules.collect { |submodule| ':' + submodule }
 
           gsub_file sorcery_config_path, /submodules = \[.*\]/ do |str|
-            current_submodule_names = (str =~ /\[(.*)\]/ ? $1 : '').delete(' ').split(',')
+            current_submodule_names = (str =~ /\[(.*)\]/ ? Regexp.last_match(1) : '').delete(' ').split(',')
             "submodules = [#{(current_submodule_names | submodule_names).join(', ')}]"
           end
         end
@@ -54,7 +53,7 @@ module Sorcery
       end
 
       def inject_sorcery_to_model
-        indents = "  " * (namespaced? ? 2 : 1)
+        indents = '  ' * (namespaced? ? 2 : 1)
 
         inject_into_class(model_path, model_class_name, "#{indents}authenticates_with_sorcery!\n")
       end
@@ -63,33 +62,40 @@ module Sorcery
       def copy_migration_files
         # Copy core migration file in all cases except when you pass --only-submodules.
         return unless defined?(Sorcery::Generators::InstallGenerator::ActiveRecord)
-        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless only_submodules?
+        migration_template 'migration/core.rb', 'db/migrate/sorcery_core.rb', migration_class_name: migration_class_name unless only_submodules?
 
         if submodules
           submodules.each do |submodule|
-            unless submodule == "http_basic_auth" || submodule == "session_timeout" || submodule == "core"
-              migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb"
+            unless submodule == 'http_basic_auth' || submodule == 'session_timeout' || submodule == 'core'
+              migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb", migration_class_name: migration_class_name
             end
           end
         end
-
       end
 
       # Define the next_migration_number method (necessary for the migration_template method to work)
       def self.next_migration_number(dirname)
         if ActiveRecord::Base.timestamped_migrations
           sleep 1 # make sure each time we get a different timestamp
-          Time.new.utc.strftime("%Y%m%d%H%M%S")
+          Time.new.utc.strftime('%Y%m%d%H%M%S')
         else
-          "%.3d" % (current_migration_number(dirname) + 1)
+          '%.3d' % (current_migration_number(dirname) + 1)
         end
       end
 
       private
+
       def only_submodules?
         options[:migrations] || options[:only_submodules]
       end
 
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        else
+          'ActiveRecord::Migration'
+        end
+      end
     end
   end
 end