gregbell/active_admin

View on GitHub
lib/active_admin/resource.rb

Summary

Maintainability
A
3 hrs
Test Coverage
# frozen_string_literal: true
require "active_admin/view_helpers/method_or_proc_helper"
require "active_admin/resource/action_items"
require "active_admin/resource/attributes"
require "active_admin/resource/controllers"
require "active_admin/resource/menu"
require "active_admin/resource/page_presenters"
require "active_admin/resource/pagination"
require "active_admin/resource/routes"
require "active_admin/resource/naming"
require "active_admin/resource/scopes"
require "active_admin/resource/includes"
require "active_admin/resource/scope_to"
require "active_admin/resource/sidebars"
require "active_admin/resource/belongs_to"
require "active_admin/resource/ordering"
require "active_admin/resource/model"

module ActiveAdmin

  # Resource is the primary data storage for resource configuration in Active Admin
  #
  # When you register a resource (ActiveAdmin.register Post) you are actually creating
  # a new Resource instance within the given Namespace.
  #
  # The instance of the current resource is available in ResourceController and views
  # by calling the #active_admin_config method.
  #
  class Resource

    # Event dispatched when a new resource is registered
    RegisterEvent = "active_admin.resource.register".freeze

    # The namespace this config belongs to
    attr_reader :namespace

    # The name of the resource class
    attr_reader :resource_class_name

    # An array of member actions defined for this resource
    attr_reader :member_actions

    # An array of collection actions defined for this resource
    attr_reader :collection_actions

    # The default sort order to use in the controller
    attr_writer :sort_order
    def sort_order
      @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : "id") + "_desc"
    end

    # Set the configuration for the CSV
    attr_writer :csv_builder

    # Set breadcrumb builder
    attr_writer :breadcrumb

    #Set order clause
    attr_writer :order_clause
    # Display create another checkbox on a new page
    # @return [Boolean]
    attr_writer :create_another

    # Store a reference to the DSL so that we can dereference it during garbage collection.
    attr_accessor :dsl

    # The string identifying a class to decorate our resource with for the view.
    # nil to not decorate.
    attr_accessor :decorator_class_name

    module Base
      def initialize(namespace, resource_class, options = {})
        @namespace = namespace
        @resource_class_name = "::#{resource_class.name}"
        @options = options
        @sort_order = options[:sort_order]
        @member_actions = []
        @collection_actions = []
      end
    end

    include MethodOrProcHelper

    include Base
    include ActionItems
    include Authorization
    include Controllers
    include Menu
    include Naming
    include PagePresenters
    include Pagination
    include Scopes
    include Includes
    include ScopeTo
    include Sidebars
    include Routes
    include Ordering
    include Attributes

    # The class this resource wraps. If you register the Post model, Resource#resource_class
    # will point to the Post class
    def resource_class
      resource_class_name.constantize
    end

    def decorator_class
      decorator_class_name&.constantize
    end

    def resource_name_extension
      @resource_name_extension ||= define_resource_name_extension(self)
    end

    def resource_table_name
      resource_class.quoted_table_name
    end

    def resource_column_names
      resource_class.column_names
    end

    def resource_quoted_column_name(column)
      resource_class.connection.quote_column_name(column)
    end

    # Clears all the member actions this resource knows about
    def clear_member_actions!
      @member_actions = []
    end

    def clear_collection_actions!
      @collection_actions = []
    end

    # Return only defined resource actions
    def defined_actions
      controller.instance_methods.map(&:to_sym) & ResourceController::ACTIVE_ADMIN_ACTIONS
    end

    def belongs_to(target, options = {})
      @belongs_to = Resource::BelongsTo.new(self, target, options)
      self.menu_item_options = false if @belongs_to.required?
      options[:class_name] ||= @belongs_to.resource.resource_class_name if @belongs_to.resource
      controller.send :belongs_to, target, options.dup
    end

    def belongs_to_config
      @belongs_to
    end

    def belongs_to_param
      if belongs_to? && belongs_to_config.required?
        belongs_to_config.to_param
      end
    end

    # Do we belong to another resource?
    def belongs_to?
      !!belongs_to_config
    end

    # The csv builder for this resource
    def csv_builder
      @csv_builder || default_csv_builder
    end

    def breadcrumb
      instance_variable_defined?(:@breadcrumb) ? @breadcrumb : namespace.breadcrumb
    end

    def order_clause
      @order_clause || namespace.order_clause
    end

    def create_another
      instance_variable_defined?(:@create_another) ? @create_another : namespace.create_another
    end

    def find_resource(id)
      resource = resource_class.public_send *method_for_find(id)
      (decorator_class && resource) ? decorator_class.new(resource) : resource
    end

    def resource_columns
      resource_attributes.values
    end

    def resource_attributes
      @resource_attributes ||= default_attributes
    end

    def association_columns
      @association_columns ||= resource_attributes.select { |key, value| key != value }.values
    end

    def content_columns
      @content_columns ||= resource_attributes.select { |key, value| key == value }.values
    end

    private

    def method_for_find(id)
      if finder = resources_configuration[:self][:finder]
        [finder, id]
      else
        [:find_by, { resource_class.primary_key => id }]
      end
    end

    def default_csv_builder
      @default_csv_builder ||= CSVBuilder.default_for_resource(self)
    end

    def define_resource_name_extension(resource)
      Module.new do
        define_method :model_name do
          resource.resource_name
        end
      end
    end
  end # class Resource
end # module ActiveAdmin