authlogic 4.4.1 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f061d5824d3ae9539ebd01c0086805f45f7f7bf2
-  data.tar.gz: 34898459a083fe21e33f015d2828503d814596d6
+  metadata.gz: 4b4e547d67102fc738dbad4fcbdfc00c68dd3efd
+  data.tar.gz: cd63b81ab7a2d498ac4a360d62b9db5ae672f634
 SHA512:
-  metadata.gz: 18e5204b2c793b3dbe55302237451eb3a9dd5ac4746e133c99aba03884e7560333a8cd06f2d3ae2906a7eb4aff6569535db6353bee207191469889b4668757ce
-  data.tar.gz: 0b622c6a789977e062c7fd862f35d2762d46c536261766c1706572c952bd751bc10eb7d24de8d2ab881e153982d4518a75f59ccbf52715c220a49602c9b0bd68
+  metadata.gz: f038e670ad640d9e2e601f35977629a6bc82f4d658fc1939e3633077fb0b5ce7ceafb49bbed462620dd34b153e8aa364127bb68e9712ddfdad7f28227cc2dd29
+  data.tar.gz: 7b97ce1b31c9abe5bdae7cfaa364f14f905f790a52d6160a18a7312c748cb81775d176d49bfeddab27ac2e89e04be032a8f55bd084725185c2e6f30386252bc0

data/.gitignore

@@ -5,7 +5,6 @@
 *.sqlite3
 pkg/*
 coverage/*
-doc/*
 benchmarks/*
 .rvmrc
 gemfiles/Gemfile*.lock

data/CHANGELOG.md

@@ -16,6 +16,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 * Fixed
   * None
 
+## 4.4.2 (2018-09-23)
+
+* Breaking Changes
+  * None
+* Added
+  * None
+* Fixed
+  * Improved instructions in deprecation warning for validations
+
 ## 4.4.1 (2018-09-21)
 
 * Breaking Changes

data/README.md

@@ -15,7 +15,7 @@ A clean, simple, and unobtrusive ruby authentication solution.
 | Version     | Documentation |
 | ----------- | ------------- |
 | Unreleased  | https://github.com/binarylogic/authlogic/blob/master/README.md |
-| 4.4.1       | https://github.com/binarylogic/authlogic/blob/v4.4.1/README.md |
+| 4.4.2       | https://github.com/binarylogic/authlogic/blob/v4.4.2/README.md |
 | 3.7.0       | https://github.com/binarylogic/authlogic/blob/v3.7.0/README.md |
 | 2.1.11      | https://github.com/binarylogic/authlogic/blob/v2.1.11/README.rdoc |
 | 1.4.3       | https://github.com/binarylogic/authlogic/blob/v1.4.3/README.rdoc |
@@ -101,7 +101,7 @@ session = UserSession.find
 To get all of the nice authentication functionality in your model just do this:
 
 ```ruby
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   acts_as_authentic do |c|
     c.my_config_option = my_value
   end # the configuration block is optional
@@ -137,7 +137,7 @@ User.create(params[:user])
 You can switch this on and off with the following configuration:
 
 ```ruby
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   acts_as_authentic do |c|
     c.log_in_after_create = false
   end # the configuration block is optional
@@ -147,7 +147,7 @@ end
 Authlogic also updates the session when the user changes his/her password. You can also switch this on and off with the following configuration:
 
 ```ruby
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   acts_as_authentic do |c|
     c.log_in_after_password_change = false
   end # the configuration block is optional
@@ -228,6 +228,53 @@ class CreateUser < ActiveRecord::Migration
 end
 ```
 
+In the `User` model,
+
+```ruby
+class User < ApplicationRecord
+  acts_as_authentic
+
+  # Validate email, login, and password as you see fit.
+  #
+  # Authlogic < 5 added these validation for you, making them a little awkward
+  # to change. In 4.4.0, those automatic validations were deprecated. See
+  # https://github.com/binarylogic/authlogic/blob/master/doc/use_normal_rails_validation.md
+  validates :email,
+    format: {
+      with: ::Authlogic::Regex::EMAIL,
+      message: "should look like an email address."
+    },
+    length: { maximum: 100 },
+    uniqueness: {
+      case_sensitive: false,
+      if: :email_changed?
+    }
+
+  validates :login,
+    format: {
+      with: ::Authlogic::Regex::LOGIN,
+      message: "should use only letters, numbers, spaces, and .-_@+ please."
+    },
+    length: { within: 3..100 },
+    uniqueness: {
+      case_sensitive: false,
+      if: :login_changed?
+    }
+
+  validates :password,
+    confirmation: { if: :require_password? },
+    length: {
+      minimum: 8,
+      if: :require_password?
+    }
+  validates :password_confirmation,
+    length: {
+      minimum: 8,
+      if: :require_password?
+  }
+end
+```
+
 ### 2.b. Controller
 
 Your sessions controller will look just like your other controllers.

data/doc/use_normal_rails_validation.md

@@ -0,0 +1,82 @@
+# Use Normal ActiveRecord Validation
+
+In Authlogic 4.4.0, [we deprecated][1] the features of Authlogic related to
+validating email, login, and password. In 5.0.0 these features will be dropped.
+Use normal ActiveRecord validations instead.
+
+## Instructions
+
+First, disable the deprecated Authlogic validations:
+
+    acts_as_authentic do |c|
+      c.validate_email_field = false
+      c.validate_login_field = false
+      c.validate_password_field = false
+    end
+
+Then, use normal ActiveRecord validations instead. For example, instead of
+the Authlogic method validates_length_of_email_field_options, use
+
+    validates :email, length: { ... }
+
+It might be a good idea to replace these one field at a time, ie. email,
+then login, then password; one field per commit.
+
+## Default Values
+
+The following validations represent the Authlogic < 5 defaults. Merge these
+defaults with any settings you may have overwritten.
+
+```
+validates :email,
+  format: {
+    with: ::Authlogic::Regex::EMAIL,
+    message: proc {
+      ::Authlogic::I18n.t(
+        "error_messages.email_invalid",
+        default: "should look like an email address."
+      )
+    }
+  },
+  length: { maximum: 100 },
+  uniqueness: {
+    case_sensitive: false,
+    if: :email_changed?
+  }
+
+validates :login,
+  format: {
+    with: ::Authlogic::Regex::LOGIN,
+    message: proc {
+      ::Authlogic::I18n.t(
+        "error_messages.login_invalid",
+        default: "should use only letters, numbers, spaces, and .-_@+ please."
+      )
+    }
+  },
+  length: { within: 3..100 },
+  uniqueness: {
+    case_sensitive: false,
+    if: :login_changed?
+  }
+
+validates :password,
+  confirmation: { if: :require_password? },
+  length: {
+    minimum: 8,
+    if: :require_password?
+  }
+validates :password_confirmation,
+  length: {
+    minimum: 8,
+    if: :require_password?
+}
+```
+
+## Motivation
+
+The deprecated features save people some time in the begginning, when setting up
+Authlogic. But, later in the life of a project, when these settings need to
+change, it is obscure compared to normal ActiveRecord validations.
+
+[1]: https://github.com/binarylogic/authlogic/pull/623

data/lib/authlogic/acts_as_authentic/base.rb

@@ -17,7 +17,7 @@ module Authlogic
         # This includes a lot of helpful methods for authenticating records
         # which the Authlogic::Session module relies on. To use it just do:
         #
-        #   class User < ActiveRecord::Base
+        #   class User < ApplicationRecord
         #     acts_as_authentic
         #   end
         #

data/lib/authlogic/authenticates_many/association.rb

@@ -13,7 +13,7 @@ module Authlogic
     # that specific account. To implement this via ActiveRecord do something
     # like:
     #
-    #   class User < ActiveRecord::Base
+    #   class User < ApplicationRecord
     #     authenticates_many :user_sessions
     #   end
     class Association

data/lib/authlogic/authenticates_many/base.rb

@@ -3,7 +3,7 @@ module Authlogic
   # to an account, you want to make sure only users that belong to that account can
   # actually login into that account. Simple, just do:
   #
-  #   class Account < ActiveRecord::Base
+  #   class Account < ApplicationRecord
   #     authenticates_many :user_sessions
   #   end
   #

data/lib/authlogic/config.rb

@@ -2,12 +2,8 @@ module Authlogic
   module Config
     E_USE_NORMAL_RAILS_VALIDATION = <<~EOS.freeze
       This Authlogic configuration option (%s) is deprecated. Use normal
-      ActiveRecord validations instead. For example, instead of the Authlogic
-      method validates_length_of_email_field_options, you can use
-
-          validates :email, length: { ... }
-
-      These deprecated Authlogic methods will be removed in the next major version.
+      ActiveRecord validation instead. Detailed instructions:
+      https://github.com/binarylogic/authlogic/blob/master/doc/use_normal_rails_validation.md
     EOS
 
     def self.extended(klass)

data/lib/authlogic/controller_adapters/rack_adapter.rb

@@ -32,7 +32,7 @@ module Authlogic
     #       # Authlogic options go here
     #     end
     #
-    #     class User < ActiveRecord::Base
+    #     class User < ApplicationRecord
     #       acts_as_authentic
     #     end
     #

data/lib/authlogic/version.rb

@@ -16,6 +16,6 @@ module Authlogic
   #
   # @api public
   def self.gem_version
-    ::Gem::Version.new("4.4.1")
+    ::Gem::Version.new("4.4.2")
   end
 end

data/test/fixtures/companies.yml

@@ -1,5 +1,5 @@
 binary_logic:
   name: Binary Logic
-  
+
 logic_over_data:
-  name: Logic Over Data
+  name: Logic Over Data

data/test/fixtures/employees.yml

@@ -6,7 +6,7 @@ drew:
   persistence_token: 5273d85ed156e9dbd6a7c1438d319ef8c8d41dd24368db6c222de11346c7b11e53ee08d45ecf619b1c1dc91233d22b372482b751b066d0a6f6f9bac42eacaabf
   first_name: Drew
   last_name: Gainor
-  
+
 jennifer:
   company: logic_over_data
   email: jjohnson@logicoverdata.com

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authlogic
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.4.2
 platform: ruby
 authors:
 - Ben Johnson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -180,6 +180,7 @@ files:
 - Rakefile
 - UPGRADING.md
 - authlogic.gemspec
+- doc/use_normal_rails_validation.md
 - gemfiles/Gemfile.rails-4.2.x
 - gemfiles/Gemfile.rails-5.1.x
 - gemfiles/Gemfile.rails-5.2.x