Merge pull request #3418 from mamhoff/auth-configuration

Convert auth accessors to configuration object

Author: tvdeyen

README.md

@@ -146,13 +146,15 @@ The best practice is to use an initializer:
 
 ```ruby
 # config/initializers/alchemy.rb
-Alchemy.user_class_name     = 'YourUserClass'          # Defaults to 'User'
-Alchemy.current_user_method = 'current_admin_user'     # Defaults to 'current_user'
-Alchemy.signup_path         = '/your/signup/path'      # Defaults to '/signup'
-Alchemy.login_path          = '/your/login/path'       # Defaults to '/login'
-Alchemy.logout_path         = '/your/logout/path'      # Defaults to '/logout'
-Alchemy.logout_method       = 'http_verb_for_logout'   # Defaults to 'delete'
-Alchemy.unauthorized_path   = '/some/public/page'      # Defaults to '/'
+Alchemy.configure do |config|
+  config.user_class          = 'YourUserClass'          # This has to be configured
+  config.current_user_method = 'current_admin_user'     # Defaults to 'current_user'
+  config.signup_path         = '/your/signup/path'      # Defaults to '/signup'
+  config.login_path          = '/your/login/path'       # Defaults to '/login'
+  config.logout_path         = '/your/logout/path'      # Defaults to '/logout'
+  config.logout_method       = 'http_verb_for_logout'   # Defaults to 'delete'
+  config.unauthorized_path   = '/some/public/page'      # Defaults to '/'
+end
 ```
 
 The only thing Alchemy needs to know from your user class is the `alchemy_roles` method.

app/controllers/alchemy/admin/base_controller.rb

@@ -80,14 +80,14 @@ def show_error_notice(error)
       end
 
       def set_stamper
-        if Alchemy.user_class < ActiveRecord::Base
-          Alchemy.user_class.stamper = current_alchemy_user
+        if Alchemy.config.user_class.respond_to?(:stamper=)
+          Alchemy.config.user_class.stamper = current_alchemy_user
         end
       end
 
       def reset_stamper
-        if Alchemy.user_class < ActiveRecord::Base
-          Alchemy.user_class.reset_stamper
+        if Alchemy.config.user_class.respond_to?(:reset_stamper)
+          Alchemy.config.user_class.reset_stamper
         end
       end
 

app/controllers/alchemy/admin/dashboard_controller.rb

@@ -11,8 +11,8 @@ class DashboardController < Alchemy::Admin::BaseController
       def index
         @last_edited_pages = Page.all_last_edited_from(current_alchemy_user)
         @all_locked_pages = Page.locked
-        if Alchemy.user_class.respond_to?(:logged_in)
-          @online_users = Alchemy.user_class.logged_in.to_a - [current_alchemy_user]
+        if Alchemy.config.user_class.respond_to?(:logged_in)
+          @online_users = Alchemy.config.user_class.logged_in.to_a - [current_alchemy_user]
         end
         if current_alchemy_user.respond_to?(:sign_in_count) && current_alchemy_user.respond_to?(:last_sign_in_at)
           @last_sign_at = current_alchemy_user.last_sign_in_at

app/controllers/alchemy/base_controller.rb

@@ -67,7 +67,7 @@ def handle_redirect_for_user
       if can?(:index, :alchemy_admin_dashboard)
         redirect_or_render_notice
       else
-        redirect_to Alchemy.unauthorized_path
+        redirect_to Alchemy.config.unauthorized_path
       end
     end
 
@@ -95,7 +95,7 @@ def handle_redirect_for_guest
         render :permission_denied
       else
         store_location
-        redirect_to Alchemy.login_path
+        redirect_to Alchemy.config.login_path
       end
     end
 

app/controllers/alchemy/pages_controller.rb

@@ -208,8 +208,8 @@ def caching_options
     end
 
     def signup_required?
-      if Alchemy.user_class.respond_to?(:admins)
-        Alchemy.user_class.admins.empty?
+      if Alchemy.config.user_class.respond_to?(:admins)
+        Alchemy.config.user_class.admins.empty?
       end
     end
 

app/models/alchemy/attachment.rb

@@ -27,7 +27,7 @@ class Attachment < BaseRecord
 
     include Alchemy.storage_adapter.attachment_class_methods
 
-    stampable stamper_class_name: Alchemy.user_class_name
+    stampable stamper_class_name: Alchemy.config.user_class_name
 
     scope :by_file_type, ->(*file_type) do
       Alchemy.storage_adapter.by_file_type_scope(file_type)

app/models/alchemy/element.rb

@@ -61,7 +61,7 @@ class Element < BaseRecord
     #
     acts_as_list scope: [:page_version_id, :fixed, :parent_element_id]
 
-    stampable stamper_class_name: Alchemy.user_class_name
+    stampable stamper_class_name: Alchemy.config.user_class_name
 
     before_destroy :delete_all_nested_elements
 

app/models/alchemy/folded_page.rb

@@ -13,10 +13,10 @@
 module Alchemy
   class FoldedPage < BaseRecord
     belongs_to :page, inverse_of: :folded_pages
-    belongs_to :user, inverse_of: :folded_pages, class_name: Alchemy.user_class_name
+    belongs_to :user, inverse_of: :folded_pages, class_name: Alchemy.config.user_class_name
 
     def self.folded_for_user(user)
-      return none unless Alchemy.user_class < ActiveRecord::Base
+      return none unless Alchemy.config.user_class.respond_to?(:where)
 
       where(user: user, folded: true)
     end

app/models/alchemy/node.rb

@@ -8,7 +8,7 @@ class Node < BaseRecord
     before_destroy :check_if_related_node_ingredients_present
 
     acts_as_nested_set scope: "language_id", touch: true
-    stampable stamper_class_name: Alchemy.user_class_name
+    stampable stamper_class_name: Alchemy.config.user_class_name
 
     belongs_to :language, class_name: "Alchemy::Language"
     belongs_to :page, class_name: "Alchemy::Page", optional: true, inverse_of: :nodes

app/models/alchemy/page.rb

@@ -98,25 +98,25 @@ class Page < BaseRecord
 
     acts_as_nested_set(dependent: :destroy, scope: [:layoutpage, :language_id])
 
-    stampable stamper_class_name: Alchemy.user_class_name
+    stampable stamper_class_name: Alchemy.config.user_class_name
 
     belongs_to :language
 
     belongs_to :creator,
-      primary_key: Alchemy.user_class_primary_key,
-      class_name: Alchemy.user_class_name,
+      primary_key: Alchemy.config.user_class_primary_key,
+      class_name: Alchemy.config.user_class_name,
       foreign_key: :creator_id,
       optional: true
 
     belongs_to :updater,
-      primary_key: Alchemy.user_class_primary_key,
-      class_name: Alchemy.user_class_name,
+      primary_key: Alchemy.config.user_class_primary_key,
+      class_name: Alchemy.config.user_class_name,
       foreign_key: :updater_id,
       optional: true
 
     belongs_to :locker,
-      primary_key: Alchemy.user_class_primary_key,
-      class_name: Alchemy.user_class_name,
+      primary_key: Alchemy.config.user_class_primary_key,
+      class_name: Alchemy.config.user_class_name,
       foreign_key: :locked_by,
       optional: true