switch_user 1.3.1 → 1.5.3

data/lib/switch_user/base_guard.rb

@@ -1,16 +1,18 @@
+# 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
-      @request       = controller.request
-      @current_user  = provider.current_user
+      @controller = controller
+      @request = controller.request
+      @current_user = provider.current_user
       @original_user = provider.original_user
     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,11 +9,11 @@ module SwitchUser
     end
 
     def all
-      sources.flat_map { |source| source.all }
+      sources.flat_map(&:all)
     end
 
     def find_scope_id(scope_id)
-      sources.map {|source| source.find_scope_id(scope_id) }.compact.first
+      sources.map { |source| source.find_scope_id(scope_id) }.compact.first
     end
   end
 
@@ -40,11 +42,10 @@ module SwitchUser
 
   class GuestDataSource
     def all
-      [ GuestRecord.new ]
+      [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,17 +1,27 @@
+# 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)
-      klass_part = SwitchUser.provider.to_s.classify
-      klass    = "SwitchUser::Provider::#{klass_part}".constantize
+      klass_part =
+        if SwitchUser.provider.is_a?(Hash)
+          SwitchUser.provider[:name]
+        else
+          SwitchUser.provider
+        end
+
+      klass_part = klass_part.to_s.classify
+
+      klass = "SwitchUser::Provider::#{klass_part}".constantize
 
       klass.new(controller)
     end

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
 
@@ -32,14 +33,13 @@ module SwitchUser
       def original_user
         user_identifier = @controller.session[:original_user_scope_identifier]
 
-        if user_identifier
-          UserLoader.prepare(:scope_identifier => user_identifier).user
-        end
+        UserLoader.prepare(scope_identifier: user_identifier).user if user_identifier
       end
 
       def original_user=(user)
-        user_type       = user.class.to_s.underscore
-        user_identifier = "#{user_type}_#{user.id}"
+        user_type = user.class.to_s.underscore
+        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 +59,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,16 +7,16 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
-        @controller.sign_in(user)
+      def login(user, _scope = nil)
+        @controller.send(:sign_in, user)
       end
 
-      def logout(scope = nil)
-        @controller.sign_out
+      def logout(_scope = nil)
+        @controller.send(:sign_out)
       end
 
-      def current_user(scope = nil)
-        @controller.current_user
+      def current_user(_scope = nil)
+        @controller.send(:current_user)
       end
     end
   end

data/lib/switch_user/provider/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Devise < Base
@@ -6,15 +8,19 @@ module SwitchUser
         @warden = @controller.warden
       end
 
-      def login(user, scope = :user)
-        @warden.session_serializer.store(user, scope)
+      def login(user, scope = nil)
+        if SwitchUser.provider.is_a?(Hash) && SwitchUser.provider[:store_sign_in]
+          @warden.set_user(user, scope: scope)
+        else
+          @warden.session_serializer.store(user, scope)
+        end
       end
 
-      def logout(scope = :user)
+      def logout(scope = nil)
         @warden.logout(scope)
       end
 
-      def current_user(scope = :user)
+      def current_user(scope = nil)
         @warden.user(scope)
       end
     end

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

data/lib/switch_user/provider/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Session < Base
@@ -5,15 +7,15 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         @controller.session[session_key] = user.id
       end
 
-      def logout(scope = nil)
+      def logout(_scope = nil)
         @controller.session.delete(session_key)
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         @controller.current_user
       end
 

data/lib/switch_user/provider/sorcery.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module Provider
     class Sorcery < Base
@@ -5,14 +7,12 @@ module SwitchUser
         @controller = controller
       end
 
-      def login(user, scope = nil)
+      def login(user, _scope = nil)
         @controller.auto_login(user)
       end
 
-      def logout(scope = nil)
-        if SwitchUser.switch_back
-          save_original_user_identifier
-        end
+      def logout(_scope = nil)
+        save_original_user_identifier if SwitchUser.switch_back
 
         @controller.logout
 
@@ -24,12 +24,11 @@ module SwitchUser
       end
 
       def restore_original_user_identifier
-        if @original_user_scope_identifier
-          @controller.session[:original_user_scope_identifier] = @original_user_scope_identifier
-        end
+        @controller.session[:original_user_scope_identifier] =
+          @original_user_scope_identifier if @original_user_scope_identifier
       end
 
-      def current_user(scope = nil)
+      def current_user(_scope = nil)
         @controller.current_user
       end
     end

data/lib/switch_user/rails.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module SwitchUser
   class Engine < Rails::Engine
-    initializer "switch_user.view" do
-      ActiveSupport.on_load(:action_view) do
-        include SwitchUserHelper
+    initializer 'switch_user.view' do
+      config.to_prepare do
+        ActiveSupport.on_load(:action_view) do
+          include SwitchUserHelper
+        end
       end
     end
   end

data/lib/switch_user/rspec.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'switch_user/rspec/feature_helpers'
 
 require 'rspec/core'
 
 RSpec.configure do |config|
+  config.include SwitchUser::RSpecFeatureHelpers, type: :feature
 
-  config.include SwitchUser::RSpecFeatureHelpers, :type => :feature
-
-  config.before(:each, :type => :feature) do
+  config.before(:each, type: :feature) do
     allow_any_instance_of(SwitchUserController).to receive(:available?).and_return(true)
   end
-
 end

data/lib/switch_user/rspec/feature_helpers.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module SwitchUser
   module RSpecFeatureHelpers
-
     class InvalidArgument < StandardError; end
 
-    def switch_user(user_record_or_scope, user_id=nil)
+    def switch_user(user_record_or_scope, user_id = nil)
       _user_scope =
         case user_record_or_scope
         when ActiveRecord::Base
@@ -14,31 +15,29 @@ module SwitchUser
 
       _user_scope = _user_scope.to_s
 
-      unless (SwitchUser.available_scopes.include?(_user_scope) or SwitchUser.available_scopes.include?(_user_scope.to_sym))
-        raise SwitchUser::InvalidScope.new("don't allow this user sign in, please check config.available_users")
-      end
+      raise SwitchUser::InvalidScope,
+            "don't allow this user sign in, please check config.available_users" unless SwitchUser.available_scopes
+        .include?(_user_scope) || SwitchUser.available_scopes.include?(_user_scope.to_sym)
 
       _user_id =
         case user_record_or_scope
         when ActiveRecord::Base
-          identifier = SwitchUser.available_users_identifiers[_user_scope] || SwitchUser.available_users_identifiers[_user_scope.to_sym]
-          if identifier.nil?
-            raise SwitchUser::InvalidScope.new("don't allow switch this user, please check config.available_users_identifiers")
-          end
+          identifier =
+            SwitchUser.available_users_identifiers[_user_scope] ||
+              SwitchUser.available_users_identifiers[_user_scope.to_sym]
+          raise SwitchUser::InvalidScope,
+                "don't allow switch this user, please check config.available_users_identifiers" if identifier.nil?
+
           user_record_or_scope.send identifier
         else
           user_id
         end
 
-      if _user_id.to_s.empty?
-        raise InvalidArgument.new("don't allow switch this user, user_id is empty")
-      end
+      raise InvalidArgument, "don't allow switch this user, user_id is empty" if _user_id.to_s.empty?
 
       scope_identifier = "#{_user_scope}_#{_user_id}"
 
       visit "/switch_user?scope_identifier=#{scope_identifier}"
     end
-
   end
-
 end