activeadministration 0.0.1

data/lib/active_admin/resource_controller.rb

@@ -0,0 +1,50 @@
+require 'inherited_resources'
+require 'active_admin/resource_controller/action_builder'
+require 'active_admin/resource_controller/data_access'
+require 'active_admin/resource_controller/decorators'
+require 'active_admin/resource_controller/scoping'
+require 'active_admin/resource_controller/sidebars'
+require 'active_admin/resource_controller/resource_class_methods'
+
+module ActiveAdmin
+  # All Resources Controller inherits from this controller.
+  # It implements actions and helpers for resources.
+  class ResourceController < BaseController
+    layout :determine_active_admin_layout
+
+    respond_to :html, :xml, :json
+    respond_to :csv, only: :index
+
+    include ActionBuilder
+    include Decorators
+    include DataAccess
+    include Scoping
+    include Sidebars
+    extend  ResourceClassMethods
+
+    def self.active_admin_config=(config)
+      if @active_admin_config = config
+        defaults resource_class: config.resource_class,
+                 route_prefix:   config.route_prefix,
+                 instance_name:  config.resource_name.singular
+      end
+    end
+
+    # Inherited Resources uses the `self.inherited(base)` hook to add
+    # in `self.resource_class`. To override it, we need to install
+    # our resource_class method each time we're inherited from.
+    def self.inherited(base)
+      super(base)
+      base.override_resource_class_methods!
+    end
+
+    private
+
+    # Returns the renderer class to use for the given action.
+    def renderer_for(action)
+      active_admin_namespace.view_factory["#{action}_page"]
+    end
+    helper_method :renderer_for
+
+  end
+end

data/lib/active_admin/resource_controller/action_builder.rb

@@ -0,0 +1,21 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    module ActionBuilder
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def clear_member_actions!
+          active_admin_config.clear_member_actions!
+        end
+
+        def clear_collection_actions!
+          active_admin_config.clear_collection_actions!
+        end
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/resource_controller/data_access.rb

@@ -0,0 +1,284 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    # This module overrides most of the data access methods in Inherited
+    # Resources to provide Active Admin with it's data.
+    #
+    # The module also deals with authorization and resource callbacks.
+    #
+    module DataAccess
+      extend ActiveSupport::Concern
+
+      include ActiveAdmin::Callbacks
+      include ActiveAdmin::ScopeChain
+
+      included do
+        define_active_admin_callbacks :build, :create, :update, :save, :destroy
+      end
+
+      protected
+
+      # Retrieve, memoize and authorize the current collection from the db. This
+      # method delegates the finding of the collection to #find_collection.
+      #
+      # Once #collection has been called, the collection is available using
+      # either the @collection instance variable or an instance variable named
+      # after the resource that the collection is for. eg: Post => @post.
+      #
+      # @returns [ActiveRecord::Relation] The collection for the index
+      def collection
+        _collection = get_collection_ivar
+
+        return _collection if _collection
+
+        _collection = find_collection
+        authorize! ActiveAdmin::Authorization::READ, active_admin_config.resource_class
+
+        set_collection_ivar _collection
+      end
+
+
+      # Does the actual work of retrieving the current collection from the db.
+      # This is a great method to override if you would like to perform
+      # some additional db # work before your controller returns and
+      # authorizes the collection.
+      #
+      # @returns [ActiveRecord::Relation] The collectin for the index
+      def find_collection
+        collection = scoped_collection
+
+        collection = apply_authorization_scope(collection)
+        collection = apply_sorting(collection)
+        collection = apply_filtering(collection)
+        collection = apply_scoping(collection)
+        collection = apply_pagination(collection)
+        collection = apply_collection_decorator(collection)
+
+        collection
+      end
+
+
+      # Override this method in your controllers to modify the start point
+      # of our searches and index.
+      #
+      # This method should return an ActiveRecord::Relation object so that
+      # the searching and filtering can be applied on top
+      #
+      # Note, unless you are doing something special, you should use the
+      # scope_to method from the Scoping module instead of overriding this
+      # method.
+      def scoped_collection
+        end_of_association_chain
+      end
+
+      # Retrieve, memoize and authorize a resource based on params[:id]. The
+      # actual work of finding the resource is done in #find_resource.
+      #
+      # This method is used on all the member actions:
+      #
+      #   * show
+      #   * edit
+      #   * update
+      #   * destroy
+      #
+      # @returns [ActiveRecord::Base] An active record object
+      def resource
+        _resource = get_resource_ivar
+
+        return _resource if _resource
+
+        _resource = find_resource
+        authorize_resource! _resource
+
+        _resource = apply_decorator(_resource)
+
+        set_resource_ivar(_resource)
+      end
+
+      # Does the actual work of finding a resource in the database. This
+      # method uses the finder method as defined in InheritedResources.
+      #
+      # @returns [ActiveRecord::Base] An active record object.
+      def find_resource
+        scoped_collection.send(method_for_find, params[:id])
+      end
+
+
+      # Builds, memoize and authorize a new instance of the resource. The
+      # actual work of building the new instance is delegated to the
+      # #build_new_resource method.
+      #
+      # This method is used to instantiate and authorize new resources in the
+      # new and create controller actions.
+      #
+      # @returns [ActiveRecord::Base] An un-saved active record base object
+      def build_resource
+        _resource = get_resource_ivar
+
+        return _resource if _resource
+
+        _resource = build_new_resource
+
+        run_build_callbacks _resource
+        authorize_resource! _resource
+
+        _resource = apply_decorator(_resource)
+
+        set_resource_ivar(_resource)
+      end
+
+      # Builds a new resource. This method uses the method_for_build provided
+      # by Inherited Resources.
+      #
+      # @returns [ActiveRecord::Base] An un-saved active record base object
+      def build_new_resource
+        scoped_collection.send(method_for_build, *resource_params)
+      end
+
+      # Calls all the appropriate callbacks and then creates the new resource.
+      #
+      # @param [ActiveRecord::Base] object The new resource to create
+      #
+      # @returns [void]
+      def create_resource(object)
+        run_create_callbacks object do
+          save_resource(object)
+        end
+      end
+
+      # Calls all the appropriate callbacks and then saves the new resource.
+      #
+      # @param [ActiveRecord::Base] object The new resource to save
+      #
+      # @returns [void]
+      def save_resource(object)
+        run_save_callbacks object do
+          object.save
+        end
+      end
+
+      # Update an object with the given attributes. Also calls the appropriate
+      # callbacks for update action.
+      #
+      # @param [ActiveRecord::Base] object The instance to update
+      #
+      # @param [Array] attributes An array with the attributes in the first position
+      #                           and the Active Record "role" in the second. The role
+      #                           may be set to nil.
+      #
+      # @returns [void]
+      def update_resource(object, attributes)
+        if object.respond_to?(:assign_attributes)
+          object.assign_attributes(*attributes)
+        else
+          object.attributes = attributes[0]
+        end
+
+        run_update_callbacks object do
+          save_resource(object)
+        end
+      end
+
+      # Destroys an object from the database and calls appropriate callbacks.
+      #
+      # @returns [void]
+      def destroy_resource(object)
+        run_destroy_callbacks object do
+          object.destroy
+        end
+      end
+
+
+      #
+      # Collection Helper Methods
+      #
+
+
+      # Gives the authorization library a change to pre-scope the collection.
+      #
+      # In the case of the CanCan adapter, it calls `#accessible_by` on
+      # the collection.
+      #
+      # @param [ActiveRecord::Relation] collection The collection to scope
+      #
+      # @retruns [ActiveRecord::Relation] a scoped collection of query
+      def apply_authorization_scope(collection)
+        action_name = action_to_permission(params[:action])
+        active_admin_authorization.scope_collection(collection, action_name)
+      end
+
+      def apply_sorting(chain)
+        params[:order] ||= active_admin_config.sort_order
+
+        order_clause = OrderClause.new params[:order]
+
+        if order_clause.valid?
+          chain.reorder(order_clause.to_sql(active_admin_config))
+        else
+          chain # just return the chain
+        end
+      end
+
+      # Applies any Ransack search methods to the currently scoped collection.
+      # Both `search` and `ransack` are provided, but we use `ransack` to prevent conflicts.
+      def apply_filtering(chain)
+        @search = chain.ransack clean_search_params params[:q]
+        @search.result
+      end
+
+      def clean_search_params(search_params)
+        return {} unless search_params.is_a?(Hash)
+        search_params = search_params.dup
+        search_params.delete_if do |key, value|
+          value == ""
+        end
+        search_params
+      end
+
+      def apply_scoping(chain)
+        @collection_before_scope = chain
+
+        if current_scope
+          scope_chain(current_scope, chain)
+        else
+          chain
+        end
+      end
+
+      def collection_before_scope
+        @collection_before_scope
+      end
+
+      def current_scope
+        @current_scope ||= if params[:scope]
+          active_admin_config.get_scope_by_id(params[:scope]) if params[:scope]
+        else
+          active_admin_config.default_scope(self)
+        end
+      end
+
+      def apply_pagination(chain)
+        page_method_name = Kaminari.config.page_method_name
+        page = params[Kaminari.config.param_name]
+
+        chain.send(page_method_name, page).per(per_page)
+      end
+
+      def per_page
+        return max_csv_records if request.format == 'text/csv'
+        return max_per_page if active_admin_config.paginate == false
+
+        @per_page || active_admin_config.per_page
+      end
+
+      def max_csv_records
+        10_000
+      end
+
+      def max_per_page
+        10_000
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/decorators.rb

@@ -0,0 +1,100 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+    module Decorators
+      protected
+
+      def apply_decorator(resource)
+        decorate? ? decorator_class.new(resource) : resource
+      end
+
+      def apply_collection_decorator(collection)
+        if decorate?
+          collection_decorator.decorate(collection, with: decorator_class)
+        else
+          collection
+        end
+      end
+
+      # TODO: find a more suitable place for this
+      def self.undecorate_resource(resource)
+        if resource.respond_to?(:decorated?) && resource.decorated?
+          resource.model
+        else
+          resource
+        end
+      end
+
+      private
+
+      def decorate?
+        case action_name
+        when 'new', 'edit'
+          form = active_admin_config.get_page_presenter :form
+          form && form.options[:decorate] && decorator_class.present?
+        else
+          decorator_class.present?
+        end
+      end
+
+      def decorator_class
+        active_admin_config.decorator_class
+      end
+
+      def collection_decorator
+        if decorator_class
+          collection_decorator = collection_decorator_class_for(decorator_class)
+
+          delegate_collection_methods_for_draper(collection_decorator, decorator_class)
+        end
+      end
+
+      # Draper::CollectionDecorator was introduced in 1.0.0
+      # Draper::Decorator#collection_decorator_class was introduced in 1.3.0
+      def collection_decorator_class_for(decorator)
+        if Dependencies.draper?    :>=, '1.3.0'
+          decorator.collection_decorator_class
+        elsif Dependencies.draper? :>=, '1.0.0'
+          draper_collection_decorator
+        else
+          decorator
+        end
+      end
+
+      def delegate_collection_methods_for_draper(collection_decorator, resource_decorator)
+        return collection_decorator unless is_draper_collection_decorator?(collection_decorator)
+
+        decorator_name = "#{collection_decorator.name} of #{resource_decorator} with ActiveAdmin extensions"
+        decorator_class_cache[decorator_name] ||= generate_collection_decorator(collection_decorator, decorator_name)
+      end
+
+      # Create a new class that inherits from the collection decorator we are
+      # using. We use this class to delegate collection scoping methods that
+      # active_admin needs to render the table.
+      def generate_collection_decorator(parent, name)
+        klass = Class.new(parent) do
+          delegate :reorder, :page, :current_page, :total_pages, :limit_value,
+                   :total_count, :num_pages, :to_key, :group_values
+        end
+
+        klass.define_singleton_method(:name) { name }
+
+        klass
+      end
+
+      def decorator_class_cache
+        @@decorator_class_cache ||= {}
+      end
+
+      def is_draper_collection_decorator?(decorator)
+        decorator && decorator <= draper_collection_decorator
+      rescue NameError
+        false
+      end
+
+      def draper_collection_decorator
+        Draper::CollectionDecorator
+      end
+
+    end
+  end
+end