activeadmin 2.4.0

data/lib/active_admin/page_controller.rb

@@ -0,0 +1,29 @@
+module ActiveAdmin
+
+  # All Pages controllers inherit from this controller.
+  class PageController < BaseController
+
+    # Active admin actions don't require layout.  All custom actions do.
+    ACTIVE_ADMIN_ACTIONS = [:index]
+
+    actions :index
+
+    before_action :authorize_access!
+
+    def index(options = {}, &block)
+      render "active_admin/page/index"
+    end
+
+    def clear_page_actions!
+      active_admin_config.clear_page_actions!
+    end
+
+    private
+
+    def authorize_access!
+      permission = action_to_permission(params[:action])
+      authorize! permission, active_admin_config
+    end
+
+  end
+end

data/lib/active_admin/page_dsl.rb

@@ -0,0 +1,32 @@
+module ActiveAdmin
+  # This is the class where all the register_page blocks are evaluated.
+  class PageDSL < DSL
+
+    # Page content.
+    #
+    # The block should define the view using Arbre.
+    #
+    # Example:
+    #
+    #   ActiveAdmin.register "My Page" do
+    #     content do
+    #       para "Sweet!"
+    #     end
+    #   end
+    #
+    def content(options = {}, &block)
+      config.set_page_presenter :index, ActiveAdmin::PagePresenter.new(options, &block)
+    end
+
+    def page_action(name, options = {}, &block)
+      config.page_actions << ControllerAction.new(name, options)
+      controller do
+        define_method(name, &block || Proc.new {})
+      end
+    end
+
+    def belongs_to(target, options = {})
+      config.belongs_to(target, options)
+    end
+  end
+end

data/lib/active_admin/page_presenter.rb

@@ -0,0 +1,33 @@
+module ActiveAdmin
+
+  # A simple object that gets used to present different aspects of views
+  #
+  # Initialize with a set of options and a block. The options become
+  # available using hash style syntax.
+  #
+  # Usage:
+  #
+  #     presenter = PagePresenter.new as: :table do
+  #       # some awesome stuff
+  #     end
+  #
+  #     presenter[:as]    #=> :table
+  #     presenter.block   #=> The block passed in to new
+  #
+  class PagePresenter
+
+    attr_reader :block, :options
+
+    delegate :has_key?, :fetch, to: :options
+
+    def initialize(options = {}, &block)
+      @options = options
+      @block = block
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+  end
+end

data/lib/active_admin/pundit_adapter.rb

@@ -0,0 +1,81 @@
+ActiveAdmin::Dependency.pundit!
+
+require 'pundit'
+
+# Add a setting to the application to configure the pundit default policy
+ActiveAdmin::Application.inheritable_setting :pundit_default_policy, nil
+ActiveAdmin::Application.inheritable_setting :pundit_policy_namespace, nil
+
+module ActiveAdmin
+
+  class PunditAdapter < AuthorizationAdapter
+
+    def authorized?(action, subject = nil)
+      policy = retrieve_policy(subject)
+      action = format_action(action, subject)
+
+      policy.respond_to?(action) && policy.public_send(action)
+    end
+
+    def scope_collection(collection, action = Auth::READ)
+      # scoping is appliable only to read/index action
+      # which means there is no way how to scope other actions
+      Pundit.policy_scope!(user, namespace(collection))
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class && default_policy_class.const_defined?(:Scope)
+        default_policy_class::Scope.new(user, collection).resolve
+      else
+        raise e
+      end
+    end
+
+    def retrieve_policy(subject)
+      case subject
+      when nil   then Pundit.policy!(user, namespace(resource))
+      when Class then Pundit.policy!(user, namespace(subject.new))
+      else Pundit.policy!(user, namespace(subject))
+      end
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class
+        default_policy(user, subject)
+      else
+        raise e
+      end
+    end
+
+    def format_action(action, subject)
+      # https://github.com/varvet/pundit/blob/master/lib/generators/pundit/install/templates/application_policy.rb
+      case action
+      when Auth::CREATE  then :create?
+      when Auth::UPDATE  then :update?
+      when Auth::READ    then subject.is_a?(Class) ? :index? : :show?
+      when Auth::DESTROY then subject.is_a?(Class) ? :destroy_all? : :destroy?
+      else "#{action}?"
+      end
+    end
+
+    private
+
+    def namespace(object)
+      if default_policy_namespace && !object.class.to_s.include?(default_policy_namespace.to_s.camelize)
+        [default_policy_namespace.to_sym, object]
+      else
+        object
+      end
+    end
+
+    def default_policy_class
+      ActiveAdmin.application.pundit_default_policy && ActiveAdmin.application.pundit_default_policy.constantize
+    end
+
+    def default_policy(user, subject)
+      default_policy_class.new(user, subject)
+    end
+
+    def default_policy_namespace
+      ActiveAdmin.application.pundit_policy_namespace
+    end
+
+  end
+
+end

data/lib/active_admin/resource.rb

@@ -0,0 +1,220 @@
+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
+      ActiveSupport::Dependencies.constantize(resource_class_name)
+    end
+
+    def decorator_class
+      ActiveSupport::Dependencies.constantize(decorator_class_name) if decorator_class_name
+    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

data/lib/active_admin/resource/action_items.rb

@@ -0,0 +1,120 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module ActionItems
+
+      # Adds the default action items to a resource when it's initialized
+      def initialize(*args)
+        super
+        add_default_action_items
+      end
+
+      # @return [Array] The set of action items for this resource
+      def action_items
+        @action_items ||= []
+      end
+
+      # Add a new action item to a resource
+      #
+      # @param [Symbol] name
+      # @param [Hash] options valid keys include:
+      #                 :only:  A single or array of controller actions to display
+      #                         this action item on.
+      #                 :except: A single or array of controller actions not to
+      #                          display this action item on.
+      #                 :priority: A single integer value. To control the display order. Default is 10.
+      def add_action_item(name, options = {}, &block)
+        self.action_items << ActiveAdmin::ActionItem.new(name, options, &block)
+      end
+
+      def remove_action_item(name)
+        self.action_items.delete_if { |item| item.name == name }
+      end
+
+      # Returns a set of action items to display for a specific controller action
+      #
+      # @param [String, Symbol] action the action to retrieve action items for
+      #
+      # @return [Array] Array of ActionItems for the controller actions
+      def action_items_for(action, render_context = nil)
+        action_items.select { |item| item.display_on? action, render_context }.sort_by(&:priority)
+      end
+
+      # Clears all the existing action items for this resource
+      def clear_action_items!
+        @action_items = []
+      end
+
+      # Used by active_admin Base view
+      def action_items?
+        !!@action_items && @action_items.any?
+      end
+
+      private
+
+      # Adds the default action items to each resource
+      def add_default_action_items
+        add_default_new_action_item
+        add_default_edit_action_item
+        add_default_show_action_item
+      end
+
+      # Adds the default New link on index
+      def add_default_new_action_item
+        add_action_item :new, only: :index do
+          if controller.action_methods.include?('new') && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:new_model), new_resource_path
+          end
+        end
+      end
+
+      # Adds the default Edit link on show
+      def add_default_edit_action_item
+        add_action_item :edit, only: :show do
+          if controller.action_methods.include?('edit') && authorized?(ActiveAdmin::Auth::UPDATE, resource)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:edit_model), edit_resource_path(resource)
+          end
+        end
+      end
+
+      # Adds the default Destroy link on show
+      def add_default_show_action_item
+        add_action_item :destroy, only: :show do
+          if controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, resource)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:delete_model), resource_path(resource), method: :delete,
+              data: { confirm: localizer.t(:delete_confirmation) }
+          end
+        end
+      end
+
+    end
+  end
+
+  # Model class to store the data for ActionItems
+  class ActionItem
+    include ActiveAdmin::OptionalDisplay
+
+    attr_accessor :block, :name
+
+    def initialize(name, options = {}, &block)
+      @name = name
+      @options = options
+      @block = block
+      normalize_display_options!
+    end
+
+    def html_class
+      "action_item #{@options[:class]}".rstrip
+    end
+
+    def priority
+      @options[:priority] || 10
+    end
+  end
+
+end