simple_auth 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c6838ee76a4171f9949a217cb1071c3e419ff11b1c0bbf577ea05239ae2abb9
-  data.tar.gz: 84b753d0a73b218d694ec8cbce6159997a44d73c6c44f9b8338fdfbb67c8a734
+  metadata.gz: 3d766e5009401ad9ed59c71e123f83046e23ea750ed8cc1f0aa7d3d3953f4185
+  data.tar.gz: fefbd6744a260ded45f3cb53db8fb5d407b0b4c8ac1fac606a9d49ce3321379c
 SHA512:
-  metadata.gz: 8f605bdc0caad8f2c605116a1e9c293dce9ff24fd45ef63abae8084b4cc7959d94a61691df43796fa14fb2e49efcddb519cf9f20ed3172511bc0062d3ed692f2
-  data.tar.gz: b40738c8f921ffd2bbd0a865948f816e6cf5ae125e7810a443d37a5925101bf4d03e3b55f35ca9ade4ce7003cddd1cd3fb576299ff0b8314a337e609d6b740e6
+  metadata.gz: 2b07279571d5d771fe036f2102a4c9c0333aea5eb8c87816a37c5c1742fd365b60926dd59dfe5e9cd265019a99035b41d250a2d939d711836ce50d50dfcc1ba0
+  data.tar.gz: 896be7f120ffe8154a7b3cdf7b90b4782b9b2f5914454ed8745051c9b1e612180afd0929cb2cd6c5f1286a6179b92e766a697e77b17fab3905e470ec9589d5ab

data/.rubocop.yml

@@ -4,3 +4,6 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.6
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v3.1.2
+
+- Make flash message key configurable via
+  `SimpleAuth::Config#flash_message_key`.
+
 # v3.1.1
 
 - Catch exceptions related to record not found when session tries to load a
@@ -18,7 +23,8 @@
 
 # v2.0.3
 
-- Assign the raw password/confirmation, so we can apply validations on the raw value.
+- Assign the raw password/confirmation, so we can apply validations on the raw
+  value.
 
 # v2.0.2
 

data/README.md

@@ -32,6 +32,7 @@ SimpleAuth.setup do |config|
   config.scopes = %i[user admin]
   config.login_url = proc { login_path }
   config.logged_url = proc { dashboard_path }
+  config.flash_message_key = :alert
 
   config.install_helpers!
 end
@@ -143,12 +144,26 @@ These are the translations you'll need:
 en:
   simple_auth:
     user:
-      need_to_be_logged_in: "You need to be logged"
+      need_to_be_logged_in: "You need to be logged in"
       not_authorized: "You don't have permission to access this page"
 ```
 
 If you don't set these translations, a default message will be used.
 
+To display the error message, use something like `<%= flash[:alert] %>`. If you
+want to use a custom key, say `:error`, use the configuration file
+`config/initializers/simple_auth.rb` to define the new key:
+
+# config/initializers/simple_auth.rb
+SimpleAuth.setup do |config|
+  # ...
+
+  config.flash_message_key = :error
+
+  # ...
+end
+```
+
 ## Maintainer
 
 * Nando Vieira (<http://nandovieira.com>)

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/simple_auth.rb

@@ -22,6 +22,7 @@ module SimpleAuth
   end
 
   setup do |config|
+    config.flash_message_key = :alert
     config.scopes = %i[user]
     config.login_url = -> { login_path }
     config.logged_url = -> { dashboard_path }

data/lib/simple_auth/action_controller.rb

@@ -55,10 +55,11 @@ module SimpleAuth
 
     private def simple_auth_require_logged_scope(scope)
       action = RequireLoginAction.new(self, scope)
+
       return if action.valid?
 
       reset_session
-      flash[:alert] = action.message
+      flash[simple_auth.flash_message_key] = action.message
       session[:return_to] = request.fullpath if request.get?
       redirect_to instance_eval(&simple_auth.login_url)
     end

data/lib/simple_auth/config.rb

@@ -16,6 +16,10 @@ module SimpleAuth
     # Default to `dashboard_path`.
     attr_accessor :logged_url
 
+    # Set the flash message key.
+    # This will be used when setting messages for unlogged/unauthorized users.
+    attr_accessor :flash_message_key
+
     def install_helpers!
       ::ActionController::Base.include SimpleAuth::ActionController
     end

data/lib/simple_auth/templates/install/initializer.rb

@@ -20,6 +20,10 @@ SimpleAuth.setup do |config|
   # when `before_action :redirect_logged_user` filter is used.
   config.logged_url = proc { dashboard_path }
 
+  # Set the flash message key.
+  # This will be used when setting messages for unlogged/unauthorized users.
+  config.flash_message_key = :alert
+
   # Install SimpleAuth helpers to the controllers.
   config.install_helpers!
 end

data/lib/simple_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleAuth
-  VERSION = "3.1.1"
+  VERSION = "3.1.2"
 end

data/test/controllers/pages_controller_test.rb

@@ -10,11 +10,22 @@ class PagesControllerTest < ActionController::TestCase
     User.delete_all
   end
 
+  teardown do
+    SimpleAuth.config.flash_message_key = :alert
+  end
+
   test "sets flash message while redirecting unlogged user" do
     get :index
     assert_equal "You must be logged in to access this page.", flash[:alert]
   end
 
+  test "sets flash message using custom key" do
+    SimpleAuth.config.flash_message_key = :error
+
+    get :index
+    assert_equal "You must be logged in to access this page.", flash[:error]
+  end
+
   test "redirects to login url" do
     get :index
 

data/test/test_helper.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "simplecov"
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/test/"
+end
 
 require "bundler/setup"
 require "rack/test"
@@ -16,4 +18,4 @@ require "active_record"
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 require "./test/support/schema"
 
-Dir["./test/support/**/*.rb"].each {|file| require file }
+Dir["./test/support/**/*.rb"].sort.each {|file| require file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_auth
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: globalid