authlogic 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f8b47d1c4c842aff31f1d7b9851725d60773e2eea798f9adafe1e479476c5cb
-  data.tar.gz: b46bc3d9c1e08d9680ca434795d832379a3bef437b755f978c3e4d3defd47330
+  metadata.gz: 0699061fb6cde9b757291441d3cf7a6621c8f9db98904d98b2864f93297fd0ea
+  data.tar.gz: c95d14549fa390d839b165a223c887562f7a48bd06f545e93faff8e2617207f4
 SHA512:
-  metadata.gz: d4852862fc120c4c7d0f7333ee43aac4d12658db42db9ac6bb570dfae45bb3f250ebe38e8459ebae4042d6a1d0fdcad4be86f48d685dfd2635c0d90a92c899a6
-  data.tar.gz: 1371934081cd37bde0ac6e5c8ef8e3b932c050aafbfa50b022d75d48549397e303c4a5cc42a4da767b864d963a89f5f8ab370beb30a6f76f28b6ff025bf91082
+  metadata.gz: 0cf20428fcff91acadf3724ce63cc30e526019a8cc12d59d7d16e00c9c9e8e15cd3a62208f1ad641bcec0da54456809e98f2594df151826fca85de59aae1f651
+  data.tar.gz: b5d8d535a6633ed8b33805f54e70200e406d9a39061cc87f50852c74df99f3ac33bfb25fbcd47c16eda4467cd02a7f159efb5c35b1ef51f5520b93352b6c2b1d

data/.rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
   # You can run the authlogic test suite with any supported version of MRI, but the
   # linter will only care about this `TargetRubyVersion`. This should be set to the
   # lowest version of MRI that authlogic supports.
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.2
 
 # Please use normal indentation when aligning parameters.
 #
@@ -32,9 +32,22 @@ Layout/AlignParameters:
 Layout/IndentationConsistency:
   EnforcedStyle: rails
 
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
 
+Metrics/AbcSize:
+  Exclude:
+    # crypto_providers/wordpress is deprecated so we will not attempt to
+    # improve its quality.
+    - lib/authlogic/crypto_providers/wordpress.rb
+    # In an ideal world tests would be held to the same ABC metric as production
+    # code. In practice, time spent doing so is not nearly as valuable as
+    # spending the same time improving production code.
+    - test/**/*
+
 # Questionable value compared to metrics like AbcSize or CyclomaticComplexity.
 Metrics/BlockLength:
   Enabled: false
@@ -43,6 +56,16 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Exclude:
+    # crypto_providers/wordpress is deprecated so we will not attempt to
+    # improve its quality.
+    - lib/authlogic/crypto_providers/wordpress.rb
+
+# Aim for 80, but 100 is OK.
+Metrics/LineLength:
+  Max: 100
+
 # Questionable value compared to metrics like AbcSize or CyclomaticComplexity.
 Metrics/MethodLength:
   Enabled: false
@@ -65,6 +88,11 @@ Naming/HeredocDelimiterNaming:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
+# Avoid annotated tokens except in desperately complicated format strings.
+# In 99% of format strings they actually make it less readable.
+Style/FormatStringToken:
+  Enabled: false
+
 # Too subtle to lint. Guard clauses are great, use them if they help.
 Style/GuardClause:
   Enabled: false
@@ -87,3 +115,17 @@ Style/ClassAndModuleChildren:
 # they are different (http://bit.ly/2hSQAGm)
 Style/ModuleFunction:
   Enabled: false
+
+# The decision of when to use slashes `/foo/` or percent-r `%r{foo}` is too
+# subtle to lint. Use whichever requires fewer backslash escapes.
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+# We use words, like `$LOAD_PATH`, because they are much less confusing that
+# arcane symbols like `$:`. Unfortunately, we must then `require "English"` in
+# a few places, but it's worth it so that we can read our code.
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_english_names
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -8,22 +8,15 @@
 
 # Offense count: 58
 Metrics/AbcSize:
-  Max: 43
-
-# Offense count: 4
-Metrics/CyclomaticComplexity:
-  Max: 8
-
-# Offense count: 579
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 110
+  Max: 28
 
 # Offense count: 3
 Metrics/PerceivedComplexity:
   Max: 8
 
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
 # Offense count: 60
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -38,7 +31,25 @@ Style/ClassVars:
 
 # Offense count: 31
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    # Permanent exclusion
+    - test/**/*
+
+    # Temporary exclustions
+    - lib/authlogic/config.rb
+    - lib/authlogic/controller_adapters/sinatra_adapter.rb
+    - lib/authlogic/crypto_providers.rb
+    - lib/authlogic/i18n/translator.rb
+    - lib/authlogic/session/activation.rb
+    - lib/authlogic/session/active_record_trickery.rb
+    - lib/authlogic/session/existence.rb
+    - lib/authlogic/session/foundation.rb
+    - lib/authlogic/session/klass.rb
+    - lib/authlogic/session/persistence.rb
+    - lib/authlogic/session/scopes.rb
+    - lib/authlogic/test_case.rb
+    - lib/authlogic/test_case/mock_cookie_jar.rb
+    - lib/authlogic/version.rb
 
 # Offense count: 4
 Style/MethodMissing:
@@ -47,129 +58,9 @@ Style/MethodMissing:
     - 'lib/authlogic/controller_adapters/sinatra_adapter.rb'
     - 'lib/authlogic/test_case/mock_request.rb'
 
-# Offense count: 1
-Style/MixinUsage:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/base.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/password.rb'
-    - 'lib/authlogic/session/magic_states.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/Not:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/login.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/authlogic/acts_as_authentic/password.rb'
-    - 'lib/authlogic/session/brute_force_protection.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowSafeAssignment.
-Style/ParenthesesAroundCondition:
-  Exclude:
-    - 'test/test_helper.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/Proc:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/email.rb'
-    - 'lib/authlogic/session/http_auth.rb'
-    - 'test/acts_as_authentic_test/email_test.rb'
-
 # Offense count: 7
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
 # SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/RedundantBegin:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/base.rb'
-    - 'lib/authlogic/crypto_providers/bcrypt.rb'
-    - 'lib/authlogic/crypto_providers/scrypt.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/session_maintenance.rb'
-    - 'test/libs/user_session.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/perishable_token.rb'
-    - 'lib/authlogic/acts_as_authentic/restful_authentication.rb'
-    - 'lib/authlogic/controller_adapters/rack_adapter.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/session_maintenance.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles.
-# SupportedStyles: use_perl_names, use_english_names
-Style/SpecialGlobalVars:
-  EnforcedStyle: use_perl_names
-
-# Offense count: 507
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiteralsInInterpolation:
-  Exclude:
-    - 'lib/authlogic/authenticates_many/base.rb'
-    - 'lib/authlogic/session/foundation.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: MinSize, SupportedStyles.
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoredMethods.
-# IgnoredMethods: respond_to, define_method
-Style/SymbolProc:
-  Exclude:
-    - 'lib/authlogic/acts_as_authentic/persistence_token.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, MinSize, WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: brackets

data/CHANGELOG.md

@@ -9,6 +9,18 @@
 * Fixed
   * None
 
+## 4.1.0 (2018-04-24)
+
+* Breaking Changes
+  * None
+* Added
+  * None
+* Fixed
+  * None
+* Deprecated
+  * crypto_providers/wordpress.rb, without replacement
+  * restful_authentication, without replacement
+
 ## 4.0.1 (2018-03-20)
 
 * Breaking Changes

data/CONTRIBUTING.md

@@ -41,7 +41,14 @@ To run a single test:
 
 ```
 BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x \
-  bundle exec ruby –I test path/to/test.rb
+  bundle exec ruby -I test path/to/test.rb
+```
+
+Bundler can be omitted, and the latest installed version of a gem dependency
+will be used. This is only suitable for certain unit tests.
+
+```
+ruby –I test path/to/test.rb
 ```
 
 ### Linting
@@ -50,13 +57,13 @@ Running `rake` also runs a linter, rubocop. Contributions must pass both
 the linter and the tests. The linter can be run on its own.
 
 ```
-BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-3.2.x bundle exec rubocop
+BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle exec rubocop
 ```
 
 To run the tests without linting, use `rake test`.
 
 ```
-BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-3.2.x bundle exec rake test
+BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle exec rake test
 ```
 
 ### Release

data/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 gemspec
 
-gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
-gem 'sqlite3', platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
+gem "sqlite3", platforms: :ruby

data/Rakefile

@@ -1,12 +1,12 @@
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 
 Bundler.setup
 
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
   test.verbose = false
 
   # Set interpreter warning level to 1 (medium). Level 2 produces hundreds of warnings
@@ -18,4 +18,4 @@ end
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :test]
+task default: %i[rubocop test]

data/authlogic.gemspec

@@ -1,4 +1,5 @@
-$:.push File.expand_path("../lib", __FILE__)
+require "English"
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "authlogic/version"
 
 ::Gem::Specification.new do |s|
@@ -16,18 +17,18 @@ require "authlogic/version"
     "jared@jaredbeck.com"
   ]
   s.homepage = "http://github.com/binarylogic/authlogic"
-  s.summary = 'A clean, simple, and unobtrusive ruby authentication solution.'
-  s.license = 'MIT'
+  s.summary = "A clean, simple, and unobtrusive ruby authentication solution."
+  s.license = "MIT"
 
-  s.required_ruby_version = '>= 2.2.0'
-  s.add_dependency 'activerecord', ['>= 4.2', '< 5.3']
-  s.add_dependency 'activesupport', ['>= 4.2', '< 5.3']
-  s.add_dependency 'request_store', '~> 1.0'
-  s.add_dependency 'scrypt', '>= 1.2', '< 4.0'
-  s.add_development_dependency 'bcrypt', '~> 3.1'
-  s.add_development_dependency 'byebug', '~> 10.0'
-  s.add_development_dependency 'rubocop', '~> 0.51.0'
-  s.add_development_dependency 'timecop', '~> 0.7'
+  s.required_ruby_version = ">= 2.2.0"
+  s.add_dependency "activerecord", [">= 4.2", "< 5.3"]
+  s.add_dependency "activesupport", [">= 4.2", "< 5.3"]
+  s.add_dependency "request_store", "~> 1.0"
+  s.add_dependency "scrypt", ">= 1.2", "< 4.0"
+  s.add_development_dependency "bcrypt", "~> 3.1"
+  s.add_development_dependency "byebug", "~> 10.0"
+  s.add_development_dependency "rubocop", "~> 0.54.0"
+  s.add_development_dependency "timecop", "~> 0.7"
 
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/authlogic/acts_as_authentic/base.rb

@@ -11,6 +11,8 @@ module Authlogic
         end
       end
 
+      # The primary configuration of a model (often, `User`) for use with
+      # authlogic. These methods become class methods of ::ActiveRecord::Base.
       module Config
         # This includes a lot of helpful methods for authenticating records
         # which the Authlogic::Session module relies on. To use it just do:
@@ -64,7 +66,8 @@ module Authlogic
           self.acts_as_authentic_modules = modules
         end
 
-        # This is the same as add_acts_as_authentic_module, except that it removes the module from the list.
+        # This is the same as add_acts_as_authentic_module, except that it
+        # removes the module from the list.
         def remove_acts_as_authentic_module(mod)
           modules = acts_as_authentic_modules.clone
           modules.delete(mod)
@@ -74,12 +77,10 @@ module Authlogic
         private
 
           def db_setup?
-            begin
-              column_names
-              true
-            rescue StandardError
-              false
-            end
+            column_names
+            true
+          rescue StandardError
+            false
           end
 
           def first_column_to_exist(*columns_to_check)
@@ -105,7 +106,11 @@ end
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::Password
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::PerishableToken
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::PersistenceToken
+
+# RestfulAuthentication is deprecated. See comments in
+# acts_as_authentic/restful_authentication.rb
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::RestfulAuthentication
+
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::SessionMaintenance
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::SingleAccessToken
 ::ActiveRecord::Base.send :include, Authlogic::ActsAsAuthentic::ValidationsScope

data/lib/authlogic/acts_as_authentic/email.rb

@@ -46,7 +46,10 @@ module Authlogic
         def validates_length_of_email_field_options(value = nil)
           rw_config(:validates_length_of_email_field_options, value, maximum: 100)
         end
-        alias_method :validates_length_of_email_field_options=, :validates_length_of_email_field_options
+        alias_method(
+          :validates_length_of_email_field_options=,
+          :validates_length_of_email_field_options
+        )
 
         # A convenience function to merge options into the
         # validates_length_of_email_field_options. So instead of:
@@ -73,7 +76,11 @@ module Authlogic
         # To validate international email addresses, enable the provided
         # alternate regex:
         #
-        # * <tt>validates_format_of_email_field_options({:with => Authlogic::Regex.email_nonascii})</tt>
+        # ```
+        # validates_format_of_email_field_options(
+        #   with: Authlogic::Regex.email_nonascii
+        # )
+        # ```
         #
         # * <tt>Default:</tt>
         #
@@ -92,16 +99,19 @@ module Authlogic
           rw_config(
             :validates_format_of_email_field_options,
             value,
-            with: Authlogic::Regex.email,
-            message: Proc.new do
+            with: Authlogic::Regex::EMAIL,
+            message: proc do
                        I18n.t(
-                         'error_messages.email_invalid',
+                         "error_messages.email_invalid",
                          default: "should look like an email address."
                        )
                      end
           )
         end
-        alias_method :validates_format_of_email_field_options=, :validates_format_of_email_field_options
+        alias_method(
+          :validates_format_of_email_field_options=,
+          :validates_format_of_email_field_options
+        )
 
         # See merge_validates_length_of_email_field_options. The same thing
         # except for validates_format_of_email_field_options.