switch_user 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cc1c6867f857a993d2f742e22150537d5ef29aa
-  data.tar.gz: 9c4e70bd6dd34f625000e5862855fffdcb08fe27
+  metadata.gz: 49886e9e1c82e46feeb807ca7c44362dca6ebf35
+  data.tar.gz: caf2f62643f90910f792c41511ffde18cdfc19f4
 SHA512:
-  metadata.gz: c7f26cd2dff27bd70b98f84bbe7e6ab9e9fcecb68903d353b7faa3e853789cc6278773210657f281a8223d8aa6bc0f6a5041490df9a61daa6b2d6112a06c24e7
-  data.tar.gz: '08c2e33483cfbac4555843d32f408f4ff8d60c45e26e82e4d1bd65c21d6f4a9cf1a5d992a4a3c440a867bc5d05924232600a14971b5ff0522c9af828f16bf625'
+  metadata.gz: c44bffb58cfdc158faf321fe268eb63fbc2d982433c84d675918ed7f227341482bf0bf49961a2b5c0c58f29ac5f7dd59e59f588c636bc6cf2b73f6968dc9ec0b
+  data.tar.gz: d3c75243ee248fdc3bd4a136f3447d0d9432fe84d0a37cfede20409f3cede749e841e33965a86e58396b646feade108cec0ef40bc34883c78f7f60457f25c0e3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+## 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`.

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)
+[![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.
 

data/Rakefile

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

data/app/controllers/switch_user_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SwitchUserController < ApplicationController
   before_action :developer_modes_only, :switch_back
 
@@ -25,13 +27,13 @@ class SwitchUserController < ApplicationController
 
   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"
+      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?
@@ -55,7 +57,7 @@ class SwitchUserController < ApplicationController
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUserHelper
   SelectOption = Struct.new(:label, :scope_id)
   def switch_user_select(options = {})
@@ -11,23 +13,21 @@ module SwitchUserHelper
         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
+        next unless selected_user.nil?
+        next if record.is_a?(SwitchUser::GuestRecord)
+        if provider.current_user?(record.user, record.scope)
+          selected_user = record.scope_id
         end
       end
     end
 
     option_tags = grouped_options_for_select(grouped_options_container.to_a, selected_user)
 
-    render partial: "switch_user/widget",
+    render partial: 'switch_user/widget',
            locals: {
              option_tags: option_tags,
              classes: options[:class],
-             styles: options[:style],
+             styles: options[:style]
            }
   end
 

data/config/routes.rb

@@ -1,3 +1,5 @@
+# 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'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Generators
     class InstallGenerator < Rails::Generators::Base
@@ -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
@@ -24,17 +26,17 @@ SwitchUser.setup do |config|
   # 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 = ->(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 = ->(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 = ->(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
@@ -56,10 +56,10 @@ module SwitchUser
     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.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

data/lib/switch_user/base_guard.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SwitchUser
   class BaseGuard
-    # TODO is this the best arguments for the initializer ?
+    # TODO: is this the best arguments for the initializer ?
     # TODO should @provider be set and current/original_user be added as # accessors ?
     def initialize(controller, provider)
       @controller    = controller
@@ -10,7 +12,7 @@ module SwitchUser
     end
 
     def controller_available?
-      raise NotImplementedError.new("you must implement controller_available?")
+      raise NotImplementedError, 'you must implement controller_available?'
     end
 
     def view_available?

data/lib/switch_user/data_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   class DataSources
     attr_reader :sources
@@ -7,7 +9,7 @@ module SwitchUser
     end
 
     def all
-      sources.flat_map { |source| source.all }
+      sources.flat_map(&:all)
     end
 
     def find_scope_id(scope_id)
@@ -43,8 +45,7 @@ module SwitchUser
       [GuestRecord.new]
     end
 
-    def find_scope_id(scope_id)
-    end
+    def find_scope_id(scope_id); end
   end
 
   class Record
@@ -70,10 +71,9 @@ module SwitchUser
 
   class GuestRecord
     def label
-      "Guest"
+      'Guest'
     end
 
-    def scope_id
-    end
+    def scope_id; end
   end
 end

data/lib/switch_user/lambda_guard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   class LambdaGuard < BaseGuard
     def controller_available?

data/lib/switch_user/provider.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
-    autoload :Base, "switch_user/provider/base"
-    autoload :Authlogic, "switch_user/provider/authlogic"
-    autoload :Clearance, "switch_user/provider/clearance"
-    autoload :Devise, "switch_user/provider/devise"
-    autoload :RestfulAuthentication, "switch_user/provider/restful_authentication"
-    autoload :Sorcery, "switch_user/provider/sorcery"
-    autoload :Dummy, "switch_user/provider/dummy"
-    autoload :Session, "switch_user/provider/session"
+    autoload :Base, 'switch_user/provider/base'
+    autoload :Authlogic, 'switch_user/provider/authlogic'
+    autoload :Clearance, 'switch_user/provider/clearance'
+    autoload :Devise, 'switch_user/provider/devise'
+    autoload :RestfulAuthentication, 'switch_user/provider/restful_authentication'
+    autoload :Sorcery, 'switch_user/provider/sorcery'
+    autoload :Dummy, 'switch_user/provider/dummy'
+    autoload :Session, 'switch_user/provider/session'
 
     def self.init(controller)
-      if SwitchUser.provider.is_a?(Hash)
-        klass_part = SwitchUser.provider[:name]
-      else
-        klass_part = SwitchUser.provider
-      end
+      klass_part = if SwitchUser.provider.is_a?(Hash)
+                     SwitchUser.provider[:name]
+                   else
+                     SwitchUser.provider
+                   end
 
       klass_part = klass_part.to_s.classify
 

data/lib/switch_user/provider/authlogic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Authlogic < Base
@@ -5,19 +7,17 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         UserSession.create(user)
       end
 
-      def logout(scope = nil)
+      def logout(_scope = nil)
         @controller.current_user_session.destroy
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         result = UserSession.find
-        if result
-          result.record
-        end
+        result&.record
       end
     end
   end

data/lib/switch_user/provider/base.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Base
       def current_users_without_scope
-        SwitchUser.available_scopes.inject([]) do |users, scope|
+        SwitchUser.available_scopes.each_with_object([]) do |scope, users|
           user = current_user(scope)
           users << user if user
-          users
         end
       end
 
@@ -39,7 +40,8 @@ module SwitchUser
 
       def original_user=(user)
         user_type       = user.class.to_s.underscore
-        user_identifier = "#{user_type}_#{user.id}"
+        column_name     = SwitchUser.available_users_identifiers[user_type.to_sym]
+        user_identifier = "#{user_type}_#{user.send(column_name)}"
 
         @controller.session[:original_user_scope_identifier] = user_identifier
       end
@@ -59,7 +61,6 @@ module SwitchUser
       def current_user?(user, scope = :user)
         current_user(scope) == user
       end
-
     end
   end
 end

data/lib/switch_user/provider/clearance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Clearance < Base
@@ -5,15 +7,15 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         @controller.sign_in(user)
       end
 
-      def logout(scope = nil)
+      def logout(_scope = nil)
         @controller.sign_out
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         @controller.current_user
       end
     end

data/lib/switch_user/provider/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Devise < Base

data/lib/switch_user/provider/dummy.rb

@@ -1,32 +1,28 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Dummy < Base
-      def initialize(controller)
+      def initialize(_controller)
         @user = nil
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         @user = user
       end
 
-      def logout(scope = nil)
+      def logout(_scope = nil)
         @user = nil
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         @user
       end
 
-      def original_user
-        @original_user
-      end
+      attr_reader :original_user
 
       def remember_current_user(remember)
-        if remember
-          @original_user = current_user
-        else
-          @original_user = nil
-        end
+        @original_user = (current_user if remember)
       end
     end
   end

data/lib/switch_user/provider/restful_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class RestfulAuthentication < Base
@@ -5,15 +7,15 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         @controller.current_user = user
       end
 
-      def logout(scope = nil)
+      def logout(_scope = nil)
         @controller.logout_killing_session!
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         @controller.current_user
       end
     end