tb_core 1.4.3.1 → 1.4.4

data/app/controllers/admin/application_controller.rb

@@ -1,6 +1,5 @@
 class Admin::ApplicationController < TbCore::ApplicationController
-  include TbCore::SortableParams
-
+  include TbCore::BelongsToApp
   before_action :require_admin_user
   add_breadcrumb 'Dashboard', :admin_root_path
   layout 'admin/detail'

data/app/controllers/admin/dashboard_controller.rb

@@ -5,7 +5,7 @@ class Admin::DashboardController < Admin::ApplicationController
 
   def index
     @setting = SpudUserSetting.find_by(spud_user_id: current_user.id, key: 'dash_icon_order')
-    apps = Spud::Core.admin_applications
+    apps = TbCore.admin_applications
     if @setting.nil? == false
       apps = arrange_apps(apps)
     end
@@ -27,7 +27,7 @@ class Admin::DashboardController < Admin::ApplicationController
 
   def badges
     data = []
-    @admin_applications = Spud::Core.admin_applications.select do |admin_application|
+    @admin_applications = TbCore.admin_applications.select do |admin_application|
       if current_user.can_view_app?(admin_application)
         if admin_application[:badge]
           data << {key: admin_application[:key], badge_count: admin_application[:badge].call(current_user)}

data/app/controllers/admin/settings_controller.rb

@@ -4,7 +4,7 @@ class Admin::SettingsController < Admin::ApplicationController
   skip_before_action :require_admin_user
 
   before_action do |c|
-    if current_user && current_user.has_admin_rights?
+    if current_user&.admin_rights?
       add_breadcrumb 'Settings', :admin_settings_path
     end
   end
@@ -34,7 +34,7 @@ private
   end
 
   def check_password
-    if user_params[:password].nil? || user_params[:password].empty?
+    if user_params[:password].blank?
       return true
     else
       if !current_user.valid_password?(params[:current_password])

data/app/controllers/admin/users_controller.rb

@@ -25,8 +25,8 @@ class Admin::UsersController < Admin::ApplicationController
 
   def export
     users = SpudUser.all
-    export_columns = %w(created_at first_name last_name email last_login_at)
-    file_name = Spud::Core.site_name + ' Users Export.csv'
+    export_columns = %w[created_at first_name last_name email last_login_at]
+    file_name = TbCore.site_name + ' Users Export.csv'
     send_data users.as_csv(export_columns),
       type: 'text/csv; charset=iso-8859-1; header=present',
       disposition: "attachment; filename=#{file_name}"
@@ -83,10 +83,7 @@ class Admin::UsersController < Admin::ApplicationController
 private
 
   def load_user
-    @user = SpudUser.find(params[:id])
-    if @user.blank?
-      raise Spud::NotFoundError.new('user')
-    end
+    @user = SpudUser.find_by!(id: params[:id])
   end
 
   def user_params
@@ -94,7 +91,7 @@ private
   end
 
   def send_credentials_email
-    if params[:send_email] && user_params[:password] && !@user.errors.any?
+    if params[:send_email] && user_params[:password] && @user.errors.none?
       TbCoreMailer.user_credentials(@user, user_params[:password]).deliver_later
     end
     return true

data/app/controllers/concerns/tb_core/error_handling.rb

@@ -3,7 +3,7 @@ module TbCore
     extend ActiveSupport::Concern
 
     included do
-      rescue_from Spud::RequestError, with: :handle_request_error
+      rescue_from RequestError, with: :handle_request_error
       rescue_from ActiveRecord::RecordNotFound, with: :handle_record_not_found
       rescue_from ActionController::UnknownFormat, with: :handle_unknown_format_error
     end
@@ -12,7 +12,7 @@ module TbCore
       error.request_url = request.original_url
       error.template = template_for_request_error() if respond_to?(:template_for_request_error, true)
 
-      if error.is_a?(Spud::UnauthorizedError) && request.format.html?
+      if error.is_a?(UnauthorizedError) && request.format.html?
         redirect_to(login_path_for_require_user)
         return false
       end
@@ -35,15 +35,24 @@ module TbCore
       end
     end
 
-    def handle_record_not_found(error)
-      error = Spud::NotFoundError.new('record')
+    def handle_record_not_found(e)
+      error = NotFoundError.new(class_string(e.model))
       handle_request_error(error)
     end
 
-    def handle_unknown_format_error(error)
-      error = Spud::NotFoundError.new()
-      handle_request_error(error)
+    def class_string(model_name)
+      string = 'record'
+      begin
+        object_class = Object.const_get(model_name)
+        string = object_class.model_name.human
+      rescue NameError # rubocop:disable Lint/HandleExceptions
+      end
+      string
     end
 
+    def handle_unknown_format_error(_e)
+      error = NotFoundError.new()
+      handle_request_error(error)
+    end
   end
 end

data/app/controllers/concerns/tb_core/user_authentication.rb

@@ -15,7 +15,7 @@ module TbCore
 
     def current_user
       return @current_user if defined?(@current_user)
-      @current_user = current_user_session && current_user_session.spud_user
+      @current_user = current_user_session&.spud_user
     end
 
     def current_user_id
@@ -24,13 +24,13 @@ module TbCore
     end
 
     def require_user
-      raise Spud::UnauthorizedError.new unless current_user
+      raise UnauthorizedError.new unless current_user
       true
     end
 
     def require_admin_user
-      raise Spud::UnauthorizedError.new unless current_user
-      raise Spud::AccessDeniedError.new unless current_user.has_admin_rights?
+      raise UnauthorizedError.new unless current_user
+      raise AccessDeniedError.new unless current_user.admin_rights?
       true
     end
 
@@ -43,7 +43,7 @@ module TbCore
 
     def set_time_zone
       old_time_zone = Time.zone
-      Time.zone = current_user.time_zone if current_user && current_user.time_zone.present?
+      Time.zone = current_user.time_zone if current_user&.time_zone.present?
       yield
     ensure
       Time.zone = old_time_zone

data/app/controllers/tb_core/application_controller.rb

@@ -8,7 +8,7 @@ module TbCore
     self.responder = TbCore::Responder
 
     def not_found
-      raise Spud::NotFoundError
+      raise NotFoundError
     end
 
     ActiveSupport.run_load_hooks(:tb_core_application_controller, self)

data/app/controllers/user_sessions_controller.rb

@@ -14,7 +14,7 @@ class UserSessionsController < ApplicationController
   end
 
   def create
-    @user_session = SpudUserSession.new(user_session_params.to_h)
+    @user_session = SpudUserSession.new(user_session_params)
     if @user_session.save()
       respond_with @user_session do |format|
         format.html{
@@ -35,7 +35,7 @@ class UserSessionsController < ApplicationController
   end
 
   def destroy
-    current_user_session.destroy unless current_user_session.blank?
+    current_user_session.destroy if current_user_session.present?
     respond_with({}) do |format|
       format.html{
         flash[:notice] = 'Logout successful!'

data/app/helpers/tb_core/application_helper.rb

@@ -58,49 +58,17 @@ module TbCore::ApplicationHelper
 
   def tb_page_title
     if content_for?(:title)
-      title = content_for(:title) + ' | ' + Spud::Core.site_name
+      title = content_for(:title) + ' | ' + TbCore.site_name
     elsif @page_title
-      title = @page_title + ' | ' + Spud::Core.site_name
+      title = @page_title + ' | ' + TbCore.site_name
     else
-      title = Spud::Core.site_name
+      title = TbCore.site_name
     end
     return content_tag :title, title
   end
 
-  # Build a table header for a model
-  #
-  # * path_helper: The helper method you want to use to generate URLs.
-  # * model: The class we should use for translations (optional)
-  # * permit: Array of request params that are forwarded to the sort links
-  #
-  # Example:
-  #
-  # <%= tb_table_header :admin_users_path, model: SpudUser do |t| %>
-  #   <%= t.sortable :name %>
-  #   <%= t.sortable :email %>
-  #   <%= t.header :last_login %>
-  #   <th></th>
-  # <% end %>
-  #
-  # Header labels will be pulled from en.yml. To provide a different
-  # label pass the label: option
-  #
-  # Example:
-  #
-  # <%= t.header :name, label: 'Full Name' %>
-  #
-  def tb_table_header(path_helper, model: nil, permit: [], &block)
-    header = TbCore::TableHeader.new(
-      path_helper: path_helper,
-      model: model,
-      params: params.permit(permit.concat([:sort, :dir, :search, :tab])),
-      context: self)
-    header.capture(block) if block
-    header.to_html
-  end
-
   def current_site_name
-    return Spud::Core.config.site_name
+    return TbCore.config.site_name
   end
 
   def cache_key_for_spud_collection(collection, key:'view', cache_params:[], for_user:false)

data/app/mailers/tb_core_mailer.rb

@@ -1,5 +1,5 @@
 class TbCoreMailer < ActionMailer::Base
-  default from: Spud::Core.from_address
+  default from: TbCore.from_address
   layout 'mailer'
 
   def forgot_password_notification(user, url)
@@ -7,7 +7,7 @@ class TbCoreMailer < ActionMailer::Base
     @url = url
     mail(
       to: to_address_for_user(user),
-      subject: default_i18n_subject(site_name: Spud::Core.site_name)
+      subject: default_i18n_subject(site_name: TbCore.site_name)
     )
   end
 
@@ -16,7 +16,7 @@ class TbCoreMailer < ActionMailer::Base
     @password = password
     mail(
       to: to_address_for_user(user),
-      subject: default_i18n_subject(site_name: Spud::Core.site_name)
+      subject: default_i18n_subject(site_name: TbCore.site_name)
     )
   end
 

data/app/models/concerns/tb_core/user_model.rb

@@ -0,0 +1,131 @@
+module TbCore
+  module UserModel
+    extend ActiveSupport::Concern
+
+    included do
+      self.table_name = 'spud_users'
+
+      acts_as_authentic do |c|
+        c.transition_from_crypto_providers = Authlogic::CryptoProviders::Sha512
+        c.crypto_provider = Authlogic::CryptoProviders::SCrypt
+        c.logged_in_timeout = 24.hours
+        c.login_field = :email if TbCore.config.use_email_as_login
+        if TbCore.config.user_password_length
+          c.merge_validates_length_of_password_field_options(minimum: TbCore.config.user_password_length)
+        end
+      end
+
+      belongs_to :role,
+        class_name: SpudRole.to_s, foreign_key: :spud_role_id, required: false
+      has_many :spud_user_settings,
+        dependent: :destroy, foreign_key: :spud_user_id
+
+      validates :first_name, :last_name, presence: true
+      before_validation :set_login_to_email, if: -> { TbCore.config.use_email_as_login }
+      before_update :unset_requires_password_change
+
+      scope :admins, lambda {
+        where('super_admin = 1 OR role_id IS NOT NULL')
+      }
+
+      scope :ordered, -> { order('last_name asc, first_name asc, email asc') }
+    end
+
+    module ClassMethods
+
+      # Returns an ActiveRecord::Relation performing a LIKE query against name columns
+      def where_name_like(string)
+        full_name = Arel::Nodes::NamedFunction.new(
+          'concat',
+          [arel_table[:first_name], Arel::Nodes.build_quoted(' '), arel_table[:last_name]]
+        )
+        search = '%' + string + '%'
+        where(full_name.matches(search))
+      end
+
+      # Return an array of users who have the requested permission
+      #
+      # * tag - Desired permission tag string (required)
+      # * include_supers - Whether to include super user (default: true)
+      def with_permission(tag, include_supers: true)
+        role_ids = SpudRolePermission.where(spud_permission_tag: tag).pluck(:spud_role_id).uniq()
+        if include_supers
+          where(super_admin: true).or(where(spud_role_id: role_ids))
+        else
+          where(spud_role_id: role_ids)
+        end
+      end
+
+      def as_csv(column_names)
+        CSV.generate do |csv|
+          csv << column_names
+          all.find_each do |item|
+            csv << item.attributes.values_at(*column_names)
+          end
+        end
+      end
+
+    end
+
+    def full_name
+      return login if first_name.blank? && last_name.blank?
+      [first_name, last_name].reject(&:blank?).join(' ')
+    end
+
+    def full_name_with_email
+      "#{full_name} (#{email})"
+    end
+
+    # Returns true if user can view at least one dashboard app
+    def admin_rights?
+      return true if super_admin
+      TbCore.admin_applications.find { |app| can_view_app?(app) }.present?
+    end
+
+    # Returns true if the user can view a spud app based on it's key
+    def can_view_app?(admin_application)
+      return true if super_admin?
+      key = admin_application[:key]
+      permissions.find { |p| p.apps.include?(key) }.present?
+    end
+
+    # Check if a user has a given list of permissions
+    #
+    # * if one tag is supplied, return true if the tag matches
+    # * if multiple tags are supplied, return true if ALL tags match
+    def permission?(*tags)
+      return true if super_admin?
+      my_tags = permissions.collect(&:tag)
+      tags.find { |tag| !my_tags.include?(tag) }.blank?
+    end
+
+    # Check if a user has at least one out of a given list of permissions
+    #
+    # * if one tag is supplied, return true if the tag matches
+    # * if multiple tags are supplied, return true if ANY tag matches
+    def any_permission?(*tags)
+      return true if super_admin?
+      permissions.find { |p| tags.include?(p.tag) }.present?
+    end
+
+    # Return a list of SpudPermission objects for the user's SpudRole
+    def permissions
+      return [] if role.blank?
+      role.permissions
+    end
+
+    private
+
+    def set_login_to_email
+      self.login = email if email.present?
+      true
+    end
+
+    def unset_requires_password_change
+      if password_changed? && !requires_password_change_changed?(to: true)
+        self.requires_password_change = false
+      end
+      true
+    end
+  end
+end

data/app/models/spud/spud_user_model.rb

@@ -1,144 +1,12 @@
 class Spud::SpudUserModel < ActiveRecord::Base
-  self.table_name = 'spud_users'
   self.abstract_class = true
+  include TbCore::UserModel
 
-  acts_as_authentic do |c|
-    c.transition_from_crypto_providers = Authlogic::CryptoProviders::Sha512
-    c.crypto_provider = Authlogic::CryptoProviders::SCrypt
-    c.logged_in_timeout = 24.hours
-    if Spud::Core.config.use_email_as_login
-      c.login_field = :email
-    end
-  end
-
-  belongs_to :role, class_name: 'SpudRole', foreign_key: 'spud_role_id'
-  has_many :spud_user_settings
-
-  validates :first_name, :last_name, presence: true
-  before_validation :set_login_to_email, if: ->{ Spud::Core.config.use_email_as_login }
-  before_update :unset_requires_password_change
-
-  scope :admins, ->{
-    where('super_admin = 1 OR role_id IS NOT NULL')
-  }
-
-  scope :ordered, ->{ order('last_name asc, first_name asc, email asc') }
-
-  def full_name
-    if first_name.blank? && last_name.blank?
-      return self.login
-    end
-    if self.first_name.blank?
-      return self.last_name
-    elsif self.last_name.blank?
-      return self.first_name
-    end
-    return "#{self.first_name} #{self.last_name}"
-  end
-
-  def full_name_with_email
-    return "#{full_name} (#{email})"
-  end
-
-  # Returns true if user can view at least one dashboard app
-  def has_admin_rights?
-    if self.super_admin?
-      return true
-    else
-      return Spud::Core.admin_applications.find{ |app| self.can_view_app?(app) }.present?
-    end
-  end
-
-  # Returns true if the user can view a spud app based on it's key
-  def can_view_app?(admin_application)
-    if self.super_admin?
-      return true
-    else
-      key = admin_application[:key]
-      return self.permissions.find{ |p| p.apps.include?(key) }.present?
-    end
-  end
-
-  # Check if a user has a given list of permissions
-  #
-  # * if one tag is supplied, return true if the tag matches
-  # * if multiple tags are supplied, return true if ALL tags match
-  def has_permission?(*tags)
-    if self.super_admin?
-      return true
-    else
-      my_tags = self.permissions.collect(&:tag)
-      return tags.find{ |tag| !my_tags.include?(tag) }.blank?
-    end
-  end
-
-  # Check if a user has at least one out of a given list of permissions
-  #
-  # * if one tag is supplied, return true if the tag matches
-  # * if multiple tags are supplied, return true if ANY tag matches
-  def has_any_permission?(*tags)
-    if self.super_admin?
-      return true
-    else
-      return self.permissions.find{ |p| tags.include?(p.tag) }.present?
-    end
-  end
-
-  # Return a list of SpudPermission objects for the user's SpudRole
-  def permissions
-    if !self.role
-      return []
-    else
-      return self.role.permissions
-    end
-  end
-
-  # Returns an ActiveRecord::Relation performing a LIKE query against name columns
-  def self.where_name_like(string)
-    full_name = Arel::Nodes::NamedFunction.new(
-      'concat',
-      [arel_table[:first_name], Arel::Nodes.build_quoted(' '), arel_table[:last_name]]
+  def initialize(*args)
+    ActiveSupport::Deprecation.warn(
+      'Spud::SpudUserModel has been replaced by TbCore::UserModel. See the README for details.',
+      caller
     )
-    search = '%' + string + '%'
-    where(full_name.matches(search))
-  end
-
-  # Return an array of users who have the requested permission
-  #
-  # * tag - Desired permission tag string (required)
-  # * include_supers - Whether to include super user (default: true)
-  def self.with_permission(tag, include_supers: true)
-    role_ids = SpudRolePermission.where(spud_permission_tag: tag).pluck(:spud_role_id).uniq()
-    if include_supers
-      where(super_admin: true).or(where(spud_role_id: role_ids))
-    else
-      where(spud_role_id: role_ids)
-    end
+    super
   end
-
-  def self.as_csv(column_names, options = {})
-    CSV.generate do |csv|
-      csv << column_names
-      all.each do |item|
-        csv << item.attributes.values_at(*column_names)
-      end
-    end
-  end
-
-private
-
-  def set_login_to_email
-    if self.email.present?
-      self.login = self.email
-    end
-    return true
-  end
-
-  def unset_requires_password_change
-    if password_changed? && !requires_password_change_changed?(to: true)
-      self.requires_password_change = false
-    end
-    return true
-  end
-
 end