switch_user 1.4.0 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06adf7119a277108834d59b13db51a1db026d52b
-  data.tar.gz: 993205a4f732d652bf60d4f083d2d9f0ed54b73a
+SHA256:
+  metadata.gz: d8264ad76309cd8d7761b68d34a9b5f6c4b64663375a27914a0904563109e77a
+  data.tar.gz: 1c6d21f1da42869a3c5008b0b8ed2b382f9a74f08e572ecfe8aec2502bee77c3
 SHA512:
-  metadata.gz: a190126c3a2323ff087712933e3ace25110c624435897c6df8c803959fbd288ac19130c32c90fff7215e38708730de2fa4d8568aced23d756da1b36bdfe975d5
-  data.tar.gz: 91ab7a7bba1f5535f913e230d8f42a47a9eb84b2575843e91d95ff372631dd3d5cbb1d2e05c91538faa79644f7ac22dc14e810fcc6179adfdc725f1446a77f8f
+  metadata.gz: 40ceb0b1424c19eb3bc756449f9e2b001da97cf4128a6cc645f835a851f10ea8acf0db07ab612b15590bd554bc72738dd6320e31a16f283a7bd01b41d5e43d97
+  data.tar.gz: 1fe7e2d3d61a4523d31f6697df4280b9715247b1bde06307b99df38ebebf0f92762999849210670c14171031f6cdc3fda39b58e7ad6d926912fe47af35d4d5c1

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Next Release
 
+## 1.5.3 (01/26/2021)
+
+* Fix `relative_url_root` behaviour
+
+## 1.5.3 (10/20/2020)
+
+* Fix zeitwerk autloading issue
+
+## 1.5.2 (03/01/2019)
+
+* Clearance has moved their controller methods to be private
+
+## 1.5.1 (10/28/2018)
+
+* Respect identifier when storing `original_user`
+* Refactor code by awesomecode.io
+
+## 1.5.0 (10/27/2017)
+
+* Allow `SwitchUser.switch_back` to be considered even when not calling `#remember_user`.
+* Use `redirect_back` for rails 5
+
 ## 1.4.0 (10/21/2016)
 
 * Add ability to `store_sign_in` info with devise provider

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in switch_user.gemspec

data/README.md

@@ -1,6 +1,7 @@
 # switch_user
 
-[![Build Status](https://secure.travis-ci.org/flyerhzm/switch_user.png)](http://travis-ci.org/flyerhzm/switch_user)
+[![Build Status](https://secure.travis-ci.org/flyerhzm/switch_user.svg)](http://travis-ci.org/flyerhzm/switch_user)
+[![AwesomeCode Status for flyerhzm/switch_user](https://awesomecode.io/projects/5f029f36-047b-4332-8405-9c7913b195bc/status)](https://awesomecode.io/repos/flyerhzm/switch_user)
 
 Inspired from [hobo][0], switch_user provides a convenient way to switch current user without needing to log out and log in manually.
 
@@ -14,7 +15,7 @@ switch_user is very useful in such use cases
 
 ## Example
 
-Visit here: <http://switch-user-example.heroku.com>, switch the current user in the select box.
+Visit here: <http://switch-user-example.herokuapp.com/admin>, switch the current user in the select box.
 
 And source code here: <https://github.com/flyerhzm/switch_user_example>
 
@@ -24,6 +25,9 @@ Add in Gemfile.
 ```ruby
 gem "switch_user"
 ```
+
+If you get the following error: **undefined method `before_action' for SwitchUserController:Class**, you are probably using an older version of Rails (<4). You can use this gem: https://github.com/pschambacher/rails3-before_action
+
 ## Usage
 
 Add following code into your layout page.
@@ -69,7 +73,7 @@ SwitchUser.setup do |config|
   # available_users is a hash,
   # key is the model name of user (:user, :admin, or any name you use),
   # value is a block that return the users that can be switched.
-  config.available_users = { :user => lambda { User.all } } # use User.scoped instead for rails 3.2
+  config.available_users = { user: -> { User.all } } # use User.scoped instead for rails 3.2
 
   # available_users_identifiers is a hash,
   # keys in this hash should match a key in the available_users hash
@@ -77,55 +81,55 @@ SwitchUser.setup do |config|
   # defaults to id
   # this hash is to allow you to specify a different column to
   # expose for instance a username on a User model instead of id
-  config.available_users_identifiers = { :user => :id }
+  config.available_users_identifiers = { user: :id }
 
   # available_users_names is a hash,
   # keys in this hash should match a key in the available_users hash
   # value is the column name which will be displayed in select box
-  config.available_users_names = { :user => :email }
+  config.available_users_names = { user: :email }
 
   # controller_guard is a block,
   # if it returns true, the request will continue,
   # else the request will be refused and returns "Permission Denied"
   # if you switch from "admin" to user, the current_user param is "admin"
-  config.controller_guard = lambda { |current_user, request| Rails.env.development? }
+  config.controller_guard = ->(current_user, request) { Rails.env.development? }
 
   # view_guard is a block,
   # if it returns true, the switch user select box will be shown,
   # else the select box will not be shown
   # if you switch from admin to "user", the current_user param is "user"
-  config.view_guard = lambda { |current_user, request| Rails.env.development? }
+  config.view_guard = ->(current_user, request)  { Rails.env.development? }
 
   # redirect_path is a block, it returns which page will be redirected
   # after switching a user.
-  config.redirect_path = lambda { |request, params| '/' }
+  config.redirect_path = ->(request, params) { '/' }
 end
 ```
 If you need to override the default configuration, run <code>rails g switch_user:install</code> and a copy of the configuration file will be copied to <code>config/initializers/switch_user.rb</code> in your project.
 
 If you want to switch both available users and available admins
 ```ruby
-config.available_users = { :user => lambda { User.available }, :admin => lambda { Admin.available } }
+config.available_users = { :user => -> { User.available }, :admin => -> { Admin.available } }
 ```
 If you want to use name column as the user identifier
 ```ruby
-config.available_users_identifiers => { :user => :name }
+config.available_users_identifiers => { user: :name }
 ```
 If you want to display the login field in switch user select box
 ```ruby
-config.available_users_names = { :user => :login }
+config.available_users_names = { user: :login }
 ```
 If you only allow switching from admin to user in production environment
 ```ruby
-config.controller_guard = lambda { |current_user, request| Rails.env == "production" and current_user.admin? }
+config.controller_guard = ->(current_user, request) { Rails.env.production? && current_user.admin? }
 ```
 If you only want to display switch user select box for admins in production environment
 ```ruby
-config.view_guard = lambda { |current_user, request| Rails.env == "production" and current_user and current_user.admin? }
+config.view_guard = ->(current_user, request) { Rails.env.production? && current_user && current_user.admin? }
 ```
 If you want to redirect user to "/dashboard" page
 ```ruby
-config.redirect_path = lambda { |request, params| "/dashboard" }
+config.redirect_path = ->(request, params) { "/dashboard" }
 ```
 If you want to hide a 'Guest' item in the helper dropdown list
 ```ruby
@@ -137,16 +141,14 @@ Sometimes you'll want to be able to switch to an unprivileged user and then back
 You will need to make the following modifications to your configuration:
 ```ruby
 config.switch_back = true
-config.controller_guard = lambda { |current_user, request, original_user|
-  current_user && current_user.admin? || original_user && original_user.super_admin?
-}
+config.controller_guard = ->(current_user, request, original_user) { current_user && current_user.admin? || original_user && original_user.super_admin? }
 # Do something similar for the view_guard as well.
 ```
 This example would allow an admin user to user switch_user, but would only let you switch back to another user if the original user was a super admin.
 
 ## Using SwitchUser with RSpec and Capybara
 
-Add the following code to spec/support/switch_user.rb or spec/spec_helper.rb :
+Add the following code to spec/support/switch_user.rb or spec/spec_helper.rb:
 
 ```ruby
 require 'switch_user/rspec'
@@ -157,7 +159,7 @@ You can now write your specs like so :
 ```ruby
 feature "Your feature", type: :feature do
   background do
-    @user = User.make(:email => 'user@example.com', :password => 'password')
+    @user = User.make(email: 'user@example.com', password: 'password')
   end
 
   scenario "Your scenario" do
@@ -189,6 +191,6 @@ This feature should be used with extreme caution because of the security implica
 
 ## Credit
 
-Copyright © 2010 - 2015 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright © 2010 - 2017 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
 [0]: https://github.com/tablatom/hobo

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks

data/app/controllers/switch_user_controller.rb

@@ -1,25 +1,39 @@
+# frozen_string_literal: true
+
 class SwitchUserController < ApplicationController
-  before_action :developer_modes_only
+  before_action :developer_modes_only, :switch_back
 
   def set_current_user
     handle_request(params)
 
-    redirect_to(SwitchUser.redirect_path.call(request, params))
+    redirect_path = SwitchUser.redirect_path.call(request, params)
+    if Rails.version.to_i >= 5 && redirect_path == :back
+      redirect_back(fallback_location: root_path)
+    else
+      redirect_to(redirect_path)
+    end
   end
 
   def remember_user
-    # NOOP unless the user has explicity enabled this feature
-    if SwitchUser.switch_back
-      provider.remember_current_user(params[:remember] == "true")
+    redirect_path = SwitchUser.redirect_path.call(request, params)
+    if Rails.version.to_i >= 5 && redirect_path == :back
+      redirect_back(fallback_location: root_path)
+    else
+      redirect_to(redirect_path)
     end
-
-    redirect_to(SwitchUser.redirect_path.call(request, params))
   end
 
   private
 
+  def switch_back
+    if SwitchUser.switch_back
+      provider.remember_current_user(true) if params[:remember] == 'true'
+      provider.remember_current_user(false) if params[:remember] == 'false'
+    end
+  end
+
   def developer_modes_only
-    raise ActionController::RoutingError.new('Do not try to hack us.') unless available?
+    raise ActionController::RoutingError, 'Do not try to hack us.' unless available?
   end
 
   def available?
@@ -36,14 +50,14 @@ class SwitchUserController < ApplicationController
         return
       end
       if SwitchUser.login_exclusive
-        provider.login_exclusive(record.user, :scope => record.scope)
+        provider.login_exclusive(record.user, scope: record.scope)
       else
-        provider.login_inclusive(record.user, :scope => record.scope)
+        provider.login_inclusive(record.user, scope: record.scope)
       end
     end
   end
 
-  # TODO make helper methods, so this can be eliminated from the
+  # TODO: make helper methods, so this can be eliminated from the
   # SwitchUserHelper
   def provider
     SwitchUser::Provider.init(self)

data/app/helpers/switch_user_helper.rb

@@ -1,34 +1,31 @@
+# frozen_string_literal: true
+
 module SwitchUserHelper
   SelectOption = Struct.new(:label, :scope_id)
+
   def switch_user_select(options = {})
     return unless available?
 
     selected_user = nil
 
-    grouped_options_container = {}.tap do |h|
-      SwitchUser.all_users.each do |record|
-        scope = record.is_a?(SwitchUser::GuestRecord) ? :Guest : record.scope.to_s.capitalize
-        h[scope] ||= []
-        h[scope] << [record.label, record.scope_id]
-
-        if selected_user.nil?
-          unless record.is_a?(SwitchUser::GuestRecord)
-            if provider.current_user?(record.user, record.scope)
-              selected_user = record.scope_id
-            end
-          end
+    grouped_options_container =
+      {}.tap do |h|
+        SwitchUser.all_users.each do |record|
+          scope = record.is_a?(SwitchUser::GuestRecord) ? :Guest : record.scope.to_s.capitalize
+          h[scope] ||= []
+          h[scope] << [record.label, record.scope_id]
+
+          next unless selected_user.nil?
+          next if record.is_a?(SwitchUser::GuestRecord)
+
+          selected_user = record.scope_id if provider.current_user?(record.user, record.scope)
         end
       end
-    end
 
     option_tags = grouped_options_for_select(grouped_options_container.to_a, selected_user)
 
-    render :partial => "switch_user/widget",
-           :locals => {
-             :option_tags => option_tags,
-             :classes => options[:class],
-             :styles => options[:style],
-           }
+    render partial: 'switch_user/widget',
+           locals: { option_tags: option_tags, classes: options[:class], styles: options[:style] }
   end
 
   private

data/app/views/switch_user/_widget.html.erb

@@ -1,4 +1,4 @@
 <% if SwitchUser.switch_back %>
-  <%= check_box_tag "remember_user", "remember_user", provider.original_user.present?, :onchange => "location.href = '#{ActionController::Base.relative_url_root || '/'}switch_user/remember_user?remember=' + encodeURIComponent(this.checked)" %>
+  <%= check_box_tag "remember_user", "remember_user", provider.original_user.present?, onchange: "location.href = '#{ActionController::Base.relative_url_root}/switch_user/remember_user?remember=' + encodeURIComponent(this.checked)" %>
 <% end %>
-<%= select_tag "switch_user_identifier", option_tags, :onchange => "location.href = '#{ActionController::Base.relative_url_root || '/'}switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)", :class => classes, :style => styles %>
+<%= select_tag "switch_user_identifier", option_tags, onchange: "location.href = '#{ActionController::Base.relative_url_root}/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)", class: classes, style: styles %>

data/config/routes.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
-  get :switch_user, :to => 'switch_user#set_current_user'
-  get 'switch_user/remember_user', :to => 'switch_user#remember_user'
+  get :switch_user, to: 'switch_user#set_current_user'
+  get 'switch_user/remember_user', to: 'switch_user#remember_user'
 end

data/lib/generators/switch_user/install/install_generator.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      TEMPLATES_PATH = File.expand_path('../templates', __FILE__)
+      TEMPLATES_PATH = File.expand_path('templates', __dir__)
       source_root File.expand_path(Engine.root, __FILE__)
 
       def install_initializer
@@ -10,4 +12,3 @@ module SwitchUser
     end
   end
 end
-

data/lib/generators/switch_user/install/templates/switch_user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SwitchUser.setup do |config|
   # provider may be :devise, :authlogic, :clearance, :restful_authentication, :sorcery, or :session
   config.provider = :devise
@@ -5,7 +7,7 @@ SwitchUser.setup do |config|
   # available_users is a hash,
   # key is the model name of user (:user, :admin, or any name you use),
   # value is a block that return the users that can be switched.
-  config.available_users = { :user => lambda { User.all } }
+  config.available_users = { user: -> { User.all } }
 
   # available_users_identifiers is a hash,
   # keys in this hash should match a key in the available_users hash
@@ -13,28 +15,28 @@ SwitchUser.setup do |config|
   # defaults to id
   # this hash is to allow you to specify a different column to
   # expose for instance a username on a User model instead of id
-  config.available_users_identifiers = { :user => :id }
+  config.available_users_identifiers = { user: :id }
 
   # available_users_names is a hash,
   # keys in this hash should match a key in the available_users hash
   # value is the column name which will be displayed in select box
-  config.available_users_names = { :user => :email }
+  config.available_users_names = { user: :email }
 
   # controller_guard is a block,
   # if it returns true, the request will continue,
   # else the request will be refused and returns "Permission Denied"
   # if you switch from "admin" to user, the current_user param is "admin"
-  config.controller_guard = lambda { |current_user, request| Rails.env.development? }
+  config.controller_guard = ->(_current_user, _request) { Rails.env.development? }
 
   # view_guard is a block,
   # if it returns true, the switch user select box will be shown,
   # else the select box will not be shown
   # if you switch from admin to "user", the current_user param is "user"
-  config.view_guard = lambda { |current_user, request| Rails.env.development? }
+  config.view_guard = ->(_current_user, _request) { Rails.env.development? }
 
   # redirect_path is a block, it returns which page will be redirected
   # after switching a user.
-  config.redirect_path = lambda { |request, params| '/' }
+  config.redirect_path = ->(_request, _params) { '/' }
 
   # helper_with_guest is a boolean value, if it set to false
   # the guest item in the helper won't be shown

data/lib/switch_user.rb

@@ -1,16 +1,16 @@
-if defined?(Rails)
-  require 'switch_user/rails'
-end
+# frozen_string_literal: true
+
+require 'switch_user/rails' if defined?(Rails)
 
 module SwitchUser
   require 'switch_user/data_source'
-  autoload :UserSet, "switch_user/user_set"
-  autoload :UserLoader, "switch_user/user_loader"
-  autoload :Provider, "switch_user/provider"
-  autoload :BaseGuard, "switch_user/base_guard"
+  autoload :UserSet, 'switch_user/user_set'
+  autoload :UserLoader, 'switch_user/user_loader'
+  autoload :Provider, 'switch_user/provider'
+  autoload :BaseGuard, 'switch_user/base_guard'
   autoload :LambdaGuard, 'switch_user/lambda_guard'
 
-  class InvalidScope < Exception; end
+  class InvalidScope < RuntimeError; end
 
   mattr_accessor :provider
   mattr_accessor :available_users
@@ -23,7 +23,7 @@ module SwitchUser
   mattr_accessor :login_exclusive
   mattr_accessor :controller_guard
   mattr_accessor :view_guard
-  mattr_reader   :guard_class
+  mattr_reader :guard_class
 
   def self.setup
     yield self
@@ -42,24 +42,25 @@ module SwitchUser
   end
 
   def self.data_sources
-    sources = available_users.map do |scope, loader|
-      identifier = available_users_identifiers.fetch(scope)
-      name = available_users_names.fetch(scope)
-      DataSource.new(loader, scope, identifier, name)
-    end
+    sources =
+      available_users.map do |scope, loader|
+        identifier = available_users_identifiers.fetch(scope)
+        name = available_users_names.fetch(scope)
+        DataSource.new(loader, scope, identifier, name)
+      end
     sources.unshift(GuestDataSource.new) if helper_with_guest
     DataSources.new(sources)
   end
 
   def self.reset_config
     self.provider = :devise
-    self.available_users = { :user => lambda { User.all } }
-    self.available_users_identifiers = { :user => :id }
-    self.available_users_names = { :user => :email }
-    self.guard_class = "SwitchUser::LambdaGuard"
-    self.controller_guard = lambda { |current_user, request| Rails.env.development? }
-    self.view_guard = lambda { |current_user, request| Rails.env.development? }
-    self.redirect_path = lambda { |request, params| request.env["HTTP_REFERER"] ? :back : root_path }
+    self.available_users = { user: -> { User.all } }
+    self.available_users_identifiers = { user: :id }
+    self.available_users_names = { user: :email }
+    self.guard_class = 'SwitchUser::LambdaGuard'
+    self.controller_guard = ->(_current_user, _request) { Rails.env.development? }
+    self.view_guard = ->(_current_user, _request) { Rails.env.development? }
+    self.redirect_path = ->(request, _params) { request.env['HTTP_REFERER'] ? :back : root_path }
     self.session_key = :user_id
     self.helper_with_guest = true
     self.switch_back = false